90
84
specific_files=specific_files,
91
85
extra_trees=extra_trees,
92
86
require_versioned=require_versioned,
93
include_root=include_root,
94
want_unversioned=want_unversioned,
87
include_root=include_root
97
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
98
def _iter_changes(self, *args, **kwargs):
99
return self.iter_changes(*args, **kwargs)
101
def iter_changes(self, from_tree, include_unchanged=False,
102
specific_files=None, pb=None, extra_trees=None,
103
require_versioned=True, want_unversioned=False):
90
def _iter_changes(self, from_tree, include_unchanged=False,
91
specific_file_ids=None, pb=None):
104
92
intertree = InterTree.get(from_tree, self)
105
return intertree.iter_changes(include_unchanged, specific_files, pb,
106
extra_trees, require_versioned, want_unversioned=want_unversioned)
93
return intertree._iter_changes(from_tree, self, include_unchanged,
94
specific_file_ids, pb)
108
96
def conflicts(self):
109
97
"""Get a list of the conflicts in the tree.
111
99
Each conflict is an instance of bzrlib.conflicts.Conflict.
113
return _mod_conflicts.ConflictList()
116
"""For trees that can have unversioned files, return all such paths."""
119
103
def get_parent_ids(self):
174
142
return self.bzrdir.is_control_filename(filename)
177
144
def iter_entries_by_dir(self, specific_file_ids=None):
178
145
"""Walk the tree in 'by_dir' order.
180
This will yield each entry in the tree as a (path, entry) tuple.
181
The order that they are yielded is:
183
Directories are walked in a depth-first lexicographical order,
184
however, whenever a directory is reached, all of its direct child
185
nodes are yielded in lexicographical order before yielding the
188
For example, in the tree::
198
The yield order (ignoring root) would be::
199
a, f, a/b, a/d, a/b/c, a/d/e, f/g
147
This will yield each entry in the tree as a (path, entry) tuple. The
148
order that they are yielded is: the contents of a directory are
149
preceeded by the parent of a directory, and all the contents of a
150
directory are grouped together.
201
152
return self.inventory.iter_entries_by_dir(
202
153
specific_file_ids=specific_file_ids)
204
def iter_references(self):
205
for path, entry in self.iter_entries_by_dir():
206
if entry.kind == 'tree-reference':
207
yield path, entry.file_id
209
155
def kind(self, file_id):
210
raise NotImplementedError("Tree subclass %s must implement kind"
211
% self.__class__.__name__)
213
def stored_kind(self, file_id):
214
"""File kind stored for this file_id.
216
May not match kind on disk for working trees. Always available
217
for versioned files, even when the file itself is missing.
219
return self.kind(file_id)
221
def path_content_summary(self, path):
222
"""Get a summary of the information about path.
224
:param path: A relative path within the tree.
225
:return: A tuple containing kind, size, exec, sha1-or-link.
226
Kind is always present (see tree.kind()).
227
size is present if kind is file, None otherwise.
228
exec is None unless kind is file and the platform supports the 'x'
230
sha1-or-link is the link target if kind is symlink, or the sha1 if
231
it can be obtained without reading the file.
233
raise NotImplementedError(self.path_content_summary)
235
def get_reference_revision(self, file_id, path=None):
236
raise NotImplementedError("Tree subclass %s must implement "
237
"get_reference_revision"
238
% self.__class__.__name__)
156
raise NotImplementedError("subclasses must implement kind")
240
158
def _comparison_data(self, entry, path):
241
159
"""Return a tuple of kind, executable, stat_value for a file.
249
167
raise NotImplementedError(self._comparison_data)
251
def _file_size(self, entry, stat_value):
169
def _file_size(entry, stat_value):
252
170
raise NotImplementedError(self._file_size)
254
172
def _get_inventory(self):
255
173
return self._inventory
257
def get_file(self, file_id, path=None):
258
"""Return a file object for the file file_id in the tree.
260
If both file_id and path are defined, it is implementation defined as
261
to which one is used.
175
def get_file(self, file_id):
176
"""Return a file object for the file file_id in the tree."""
263
177
raise NotImplementedError(self.get_file)
265
def get_file_mtime(self, file_id, path=None):
266
"""Return the modification time for a file.
268
:param file_id: The handle for this file.
269
:param path: The path that this file can be found at.
270
These must point to the same object.
272
raise NotImplementedError(self.get_file_mtime)
274
def get_file_size(self, file_id):
275
"""Return the size of a file in bytes.
277
This applies only to regular files. If invoked on directories or
278
symlinks, it will return None.
279
:param file_id: The file-id of the file
281
raise NotImplementedError(self.get_file_size)
283
179
def get_file_by_path(self, path):
284
return self.get_file(self._inventory.path2id(path), path)
286
def iter_files_bytes(self, desired_files):
287
"""Iterate through file contents.
289
Files will not necessarily be returned in the order they occur in
290
desired_files. No specific order is guaranteed.
292
Yields pairs of identifier, bytes_iterator. identifier is an opaque
293
value supplied by the caller as part of desired_files. It should
294
uniquely identify the file version in the caller's context. (Examples:
295
an index number or a TreeTransform trans_id.)
297
bytes_iterator is an iterable of bytestrings for the file. The
298
kind of iterable and length of the bytestrings are unspecified, but for
299
this implementation, it is a tuple containing a single bytestring with
300
the complete text of the file.
302
:param desired_files: a list of (file_id, identifier) pairs
304
for file_id, identifier in desired_files:
305
# We wrap the string in a tuple so that we can return an iterable
306
# of bytestrings. (Technically, a bytestring is also an iterable
307
# of bytestrings, but iterating through each character is not
309
cur_file = (self.get_file_text(file_id),)
310
yield identifier, cur_file
312
def get_symlink_target(self, file_id):
313
"""Get the target for a given file_id.
315
It is assumed that the caller already knows that file_id is referencing
317
:param file_id: Handle for the symlink entry.
318
:return: The path the symlink points to.
320
raise NotImplementedError(self.get_symlink_target)
322
def get_root_id(self):
323
"""Return the file_id for the root of this tree."""
324
raise NotImplementedError(self.get_root_id)
326
def annotate_iter(self, file_id,
327
default_revision=_mod_revision.CURRENT_REVISION):
328
"""Return an iterator of revision_id, line tuples.
180
return self.get_file(self._inventory.path2id(path))
182
def annotate_iter(self, file_id):
183
"""Return an iterator of revision_id, line tuples
330
185
For working trees (and mutable trees in general), the special
331
186
revision_id 'current:' will be used for lines that are new in this
332
187
tree, e.g. uncommitted changes.
333
188
:param file_id: The file to produce an annotated version from
334
:param default_revision: For lines that don't match a basis, mark them
335
with this revision id. Not all implementations will make use of
338
190
raise NotImplementedError(self.annotate_iter)
340
def _get_plan_merge_data(self, file_id, other, base):
341
from bzrlib import merge, versionedfile
342
vf = versionedfile._PlanMergeVersionedFile(file_id)
343
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
344
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
346
last_revision_base = None
348
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
349
return vf, last_revision_a, last_revision_b, last_revision_base
351
def plan_file_merge(self, file_id, other, base=None):
352
"""Generate a merge plan based on annotations.
354
If the file contains uncommitted changes in this tree, they will be
355
attributed to the 'current:' pseudo-revision. If the file contains
356
uncommitted changes in the other tree, they will be assigned to the
357
'other:' pseudo-revision.
359
data = self._get_plan_merge_data(file_id, other, base)
360
vf, last_revision_a, last_revision_b, last_revision_base = data
361
return vf.plan_merge(last_revision_a, last_revision_b,
364
def plan_file_lca_merge(self, file_id, other, base=None):
365
"""Generate a merge plan based lca-newness.
367
If the file contains uncommitted changes in this tree, they will be
368
attributed to the 'current:' pseudo-revision. If the file contains
369
uncommitted changes in the other tree, they will be assigned to the
370
'other:' pseudo-revision.
372
data = self._get_plan_merge_data(file_id, other, base)
373
vf, last_revision_a, last_revision_b, last_revision_base = data
374
return vf.plan_lca_merge(last_revision_a, last_revision_b,
377
def _iter_parent_trees(self):
378
"""Iterate through parent trees, defaulting to Tree.revision_tree."""
379
for revision_id in self.get_parent_ids():
381
yield self.revision_tree(revision_id)
382
except errors.NoSuchRevisionInTree:
383
yield self.repository.revision_tree(revision_id)
386
def _file_revision(revision_tree, file_id):
387
"""Determine the revision associated with a file in a given tree."""
388
revision_tree.lock_read()
390
return revision_tree.inventory[file_id].revision
392
revision_tree.unlock()
394
def _get_file_revision(self, file_id, vf, tree_revision):
395
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
397
if getattr(self, '_repository', None) is None:
398
last_revision = tree_revision
399
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
400
self._iter_parent_trees()]
401
vf.add_lines((file_id, last_revision), parent_keys,
402
self.get_file(file_id).readlines())
403
repo = self.branch.repository
406
last_revision = self._file_revision(self, file_id)
407
base_vf = self._repository.texts
408
if base_vf not in vf.fallback_versionedfiles:
409
vf.fallback_versionedfiles.append(base_vf)
412
192
inventory = property(_get_inventory,
413
193
doc="Inventory of this Tree")
500
244
pred = self.inventory.has_filename
501
245
return set((p for p in paths if not pred(p)))
503
def walkdirs(self, prefix=""):
504
"""Walk the contents of this tree from path down.
506
This yields all the data about the contents of a directory at a time.
507
After each directory has been yielded, if the caller has mutated the
508
list to exclude some directories, they are then not descended into.
510
The data yielded is of the form:
511
((directory-relpath, directory-path-from-root, directory-fileid),
512
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
513
versioned_kind), ...]),
514
- directory-relpath is the containing dirs relpath from prefix
515
- directory-path-from-root is the containing dirs path from /
516
- directory-fileid is the id of the directory if it is versioned.
517
- relpath is the relative path within the subtree being walked.
518
- basename is the basename
519
- kind is the kind of the file now. If unknonwn then the file is not
520
present within the tree - but it may be recorded as versioned. See
522
- lstat is the stat data *if* the file was statted.
523
- path_from_tree_root is the path from the root of the tree.
524
- file_id is the file_id if the entry is versioned.
525
- versioned_kind is the kind of the file as last recorded in the
526
versioning system. If 'unknown' the file is not versioned.
527
One of 'kind' and 'versioned_kind' must not be 'unknown'.
529
:param prefix: Start walking from prefix within the tree rather than
530
at the root. This allows one to walk a subtree but get paths that are
531
relative to a tree rooted higher up.
532
:return: an iterator over the directory data.
534
raise NotImplementedError(self.walkdirs)
536
def iter_search_rules(self, path_names, pref_names=None,
537
_default_searcher=rules._per_user_searcher):
538
"""Find the preferences for filenames in a tree.
540
:param path_names: an iterable of paths to find attributes for.
541
Paths are given relative to the root of the tree.
542
:param pref_names: the list of preferences to lookup - None for all
543
:param _default_searcher: private parameter to assist testing - don't use
544
:return: an iterator of tuple sequences, one per path-name.
545
See _RulesSearcher.get_items for details on the tuple sequence.
547
searcher = self._get_rules_searcher(_default_searcher)
548
if searcher is not None:
549
if pref_names is not None:
550
for path in path_names:
551
yield searcher.get_selected_items(path, pref_names)
553
for path in path_names:
554
yield searcher.get_items(path)
557
def _get_rules_searcher(self, default_searcher):
558
"""Get the RulesSearcher for this tree given the default one."""
559
searcher = default_searcher
560
file_id = self.path2id(rules.RULES_TREE_FILENAME)
561
if file_id is not None:
562
ini_file = self.get_file(file_id)
563
searcher = rules._StackedRulesSearcher(
564
[rules._IniBasedRulesSearcher(ini_file), default_searcher])
568
248
class EmptyTree(Tree):
764
444
:param require_versioned: An optional boolean (defaults to False). When
765
445
supplied and True all the 'specific_files' must be versioned, or
766
446
a PathsNotVersionedError will be thrown.
767
:param want_unversioned: Scan for unversioned paths.
769
# NB: show_status depends on being able to pass in non-versioned files
770
# and report them as unknown
771
trees = (self.source,)
448
# NB: show_status depends on being able to pass in non-versioned files and
449
# report them as unknown
450
trees = (self.source, self.target)
772
451
if extra_trees is not None:
773
452
trees = trees + tuple(extra_trees)
774
# target is usually the newer tree:
775
specific_file_ids = self.target.paths2ids(specific_files, trees,
776
require_versioned=require_versioned)
453
specific_file_ids = find_ids_across_trees(specific_files,
454
trees, require_versioned=require_versioned)
777
455
if specific_files and not specific_file_ids:
778
456
# All files are unversioned, so just return an empty delta
779
457
# _compare_trees would think we want a complete delta
780
result = delta.TreeDelta()
781
fake_entry = InventoryFile('unused', 'unused', 'unused')
782
result.unversioned = [(path, None,
783
self.target._comparison_data(fake_entry, path)[0]) for path in
458
return delta.TreeDelta()
786
459
return delta._compare_trees(self.source, self.target, want_unchanged,
787
specific_files, include_root, extra_trees=extra_trees,
788
require_versioned=require_versioned,
789
want_unversioned=want_unversioned)
460
specific_file_ids, include_root)
791
def iter_changes(self, include_unchanged=False,
792
specific_files=None, pb=None, extra_trees=[],
793
require_versioned=True, want_unversioned=False):
462
def _iter_changes(self, from_tree, to_tree, include_unchanged,
463
specific_file_ids, pb):
794
464
"""Generate an iterator of changes between trees.
796
466
A tuple is returned:
797
(file_id, (path_in_source, path_in_target),
798
changed_content, versioned, parent, name, kind,
467
(file_id, path, changed_content, versioned, parent, name, kind,
801
Changed_content is True if the file's content has changed. This
802
includes changes to its kind, and to a symlink's target.
470
Path is relative to the to_tree. changed_content is True if the file's
471
content has changed. This includes changes to its kind, and to
804
474
versioned, parent, name, kind, executable are tuples of (from, to).
805
475
If a file is missing in a tree, its kind is None.
807
Iteration is done in parent-to-child order, relative to the target
810
There is no guarantee that all paths are in sorted order: the
811
requirement to expand the search due to renames may result in children
812
that should be found early being found late in the search, after
813
lexically later results have been returned.
814
:param require_versioned: Raise errors.PathsNotVersionedError if a
815
path in the specific_files list is not versioned in one of
816
source, target or extra_trees.
817
:param want_unversioned: Should unversioned files be returned in the
818
output. An unversioned file is defined as one with (False, False)
819
for the versioned pair.
477
Iteration is done in parent-to-child order, relative to the to_tree.
822
lookup_trees = [self.source]
824
lookup_trees.extend(extra_trees)
825
if specific_files == []:
826
specific_file_ids = []
828
specific_file_ids = self.target.paths2ids(specific_files,
829
lookup_trees, require_versioned=require_versioned)
831
all_unversioned = sorted([(p.split('/'), p) for p in
833
if specific_files is None or
834
osutils.is_inside_any(specific_files, p)])
835
all_unversioned = deque(all_unversioned)
837
all_unversioned = deque()
839
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
480
from_entries_by_dir = list(from_tree.inventory.iter_entries_by_dir(
840
481
specific_file_ids=specific_file_ids))
841
482
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
842
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
483
to_entries_by_dir = list(to_tree.inventory.iter_entries_by_dir(
843
484
specific_file_ids=specific_file_ids))
844
485
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
846
# the unversioned path lookup only occurs on real trees - where there
847
# can be extras. So the fake_entry is solely used to look up
848
# executable it values when execute is not supported.
849
fake_entry = InventoryFile('unused', 'unused', 'unused')
850
487
for to_path, to_entry in to_entries_by_dir:
851
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
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))
860
488
file_id = to_entry.file_id
861
489
to_paths[file_id] = to_path
878
506
from_executable = None
879
507
versioned = (from_versioned, True)
880
508
to_kind, to_executable, to_stat = \
881
self.target._comparison_data(to_entry, to_path)
509
to_tree._comparison_data(to_entry, to_path)
882
510
kind = (from_kind, to_kind)
883
511
if kind[0] != kind[1]:
884
512
changed_content = True
885
513
elif from_kind == 'file':
886
from_size = self.source._file_size(from_entry, from_stat)
887
to_size = self.target._file_size(to_entry, to_stat)
514
from_size = from_tree._file_size(from_entry, from_stat)
515
to_size = to_tree._file_size(to_entry, to_stat)
888
516
if from_size != to_size:
889
517
changed_content = True
890
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
891
self.target.get_file_sha1(file_id, to_path, to_stat)):
518
elif (from_tree.get_file_sha1(file_id, from_path, from_stat) !=
519
to_tree.get_file_sha1(file_id, to_path, to_stat)):
892
520
changed_content = True
893
521
elif from_kind == 'symlink':
894
if (self.source.get_symlink_target(file_id) !=
895
self.target.get_symlink_target(file_id)):
522
if (from_tree.get_symlink_target(file_id) !=
523
to_tree.get_symlink_target(file_id)):
896
524
changed_content = True
897
elif from_kind == 'tree-reference':
898
if (self.source.get_reference_revision(file_id, from_path)
899
!= self.target.get_reference_revision(file_id, to_path)):
900
changed_content = True
901
525
parent = (from_parent, to_entry.parent_id)
902
526
name = (from_name, to_entry.name)
903
527
executable = (from_executable, to_executable)
904
528
if pb is not None:
905
529
pb.update('comparing files', entry_count, num_entries)
906
if (changed_content is not False or versioned[0] != versioned[1]
530
if (changed_content is not False or versioned[0] != versioned[1]
907
531
or parent[0] != parent[1] or name[0] != name[1] or
908
532
executable[0] != executable[1] or include_unchanged):
909
yield (file_id, (from_path, to_path), changed_content,
910
versioned, parent, name, kind, executable)
912
while all_unversioned:
913
# yield any trailing unversioned paths
914
unversioned_path = all_unversioned.popleft()
915
to_kind, to_executable, to_stat = \
916
self.target._comparison_data(fake_entry, unversioned_path[1])
917
yield (None, (None, unversioned_path[1]), True, (False, False),
919
(None, unversioned_path[0][-1]),
921
(None, to_executable))
923
def get_to_path(to_entry):
924
if to_entry.parent_id is None:
925
to_path = '' # the root
533
yield (file_id, to_path, changed_content, versioned, parent,
534
name, kind, executable)
536
def get_to_path(from_entry):
537
if from_entry.parent_id is None:
927
if to_entry.parent_id not in to_paths:
929
return get_to_path(self.target.inventory[to_entry.parent_id])
930
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
932
to_paths[to_entry.file_id] = to_path
540
if from_entry.parent_id not in to_paths:
541
get_to_path(from_tree.inventory[from_entry.parent_id])
542
to_path = osutils.pathjoin(to_paths[from_entry.parent_id],
544
to_paths[from_entry.file_id] = to_path
935
547
for path, from_entry in from_entries_by_dir:
936
548
file_id = from_entry.file_id
937
549
if file_id in to_paths:
940
if not file_id in self.target.inventory:
941
# common case - paths we have not emitted are not present in
945
to_path = get_to_path(self.target.inventory[file_id])
551
to_path = get_to_path(from_entry)
947
553
if pb is not None:
948
554
pb.update('comparing files', entry_count, num_entries)
added
removed
bzrlib/tree.py
