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
125
raise NotImplementedError()
55
127
def has_id(self, file_id):
128
file_id = osutils.safe_file_id(file_id)
56
129
return self.inventory.has_id(file_id)
131
__contains__ = has_id
58
133
def has_or_had_id(self, file_id):
134
file_id = osutils.safe_file_id(file_id)
59
135
if file_id == self.inventory.root.file_id:
61
137
return self.inventory.has_id(file_id)
139
def is_ignored(self, filename):
140
"""Check whether the filename is ignored by this tree.
142
:param filename: The relative filename within the tree.
143
:return: True if the filename is ignored.
65
147
def __iter__(self):
66
148
return iter(self.inventory)
68
150
def id2path(self, file_id):
151
"""Return the path for a file id.
155
file_id = osutils.safe_file_id(file_id)
69
156
return self.inventory.id2path(file_id)
158
def is_control_filename(self, filename):
159
"""True if filename is the name of a control file in this tree.
161
:param filename: A filename within the tree. This is a relative path
162
from the root of this tree.
164
This is true IF and ONLY IF the filename is part of the meta data
165
that bzr controls in this tree. I.E. a random .bzr directory placed
166
on disk will not be a control file for this tree.
168
return self.bzrdir.is_control_filename(filename)
171
def iter_entries_by_dir(self, specific_file_ids=None):
172
"""Walk the tree in 'by_dir' order.
174
This will yield each entry in the tree as a (path, entry) tuple. The
175
order that they are yielded is: the contents of a directory are
176
preceeded by the parent of a directory, and all the contents of a
177
directory are grouped together.
179
return self.inventory.iter_entries_by_dir(
180
specific_file_ids=specific_file_ids)
182
def iter_references(self):
183
for path, entry in self.iter_entries_by_dir():
184
if entry.kind == 'tree-reference':
185
yield path, entry.file_id
71
187
def kind(self, file_id):
72
raise NotImplementedError("subclasses must implement kind")
188
raise NotImplementedError("Tree subclass %s must implement kind"
189
% self.__class__.__name__)
191
def get_reference_revision(self, file_id, path=None):
192
raise NotImplementedError("Tree subclass %s must implement "
193
"get_reference_revision"
194
% self.__class__.__name__)
196
def _comparison_data(self, entry, path):
197
"""Return a tuple of kind, executable, stat_value for a file.
199
entry may be None if there is no inventory entry for the file, but
200
path must always be supplied.
202
kind is None if there is no file present (even if an inventory id is
203
present). executable is False for non-file entries.
205
raise NotImplementedError(self._comparison_data)
207
def _file_size(self, entry, stat_value):
208
raise NotImplementedError(self._file_size)
74
210
def _get_inventory(self):
75
211
return self._inventory
213
def get_file(self, file_id, path=None):
214
"""Return a file object for the file file_id in the tree.
216
If both file_id and path are defined, it is implementation defined as
217
to which one is used.
219
raise NotImplementedError(self.get_file)
221
def get_file_mtime(self, file_id, path=None):
222
"""Return the modification time for a file.
224
:param file_id: The handle for this file.
225
:param path: The path that this file can be found at.
226
These must point to the same object.
228
raise NotImplementedError(self.get_file_mtime)
77
230
def get_file_by_path(self, path):
78
231
return self.get_file(self._inventory.path2id(path))
233
def iter_files_bytes(self, desired_files):
234
"""Iterate through file contents.
236
Files will not necessarily be returned in the order they occur in
237
desired_files. No specific order is guaranteed.
239
Yields pairs of identifier, bytes_iterator. identifier is an opaque
240
value supplied by the caller as part of desired_files. It should
241
uniquely identify the file version in the caller's context. (Examples:
242
an index number or a TreeTransform trans_id.)
244
bytes_iterator is an iterable of bytestrings for the file. The
245
kind of iterable and length of the bytestrings are unspecified, but for
246
this implementation, it is a tuple containing a single bytestring with
247
the complete text of the file.
249
:param desired_files: a list of (file_id, identifier) pairs
251
for file_id, identifier in desired_files:
252
# We wrap the string in a tuple so that we can return an iterable
253
# of bytestrings. (Technically, a bytestring is also an iterable
254
# of bytestrings, but iterating through each character is not
256
cur_file = (self.get_file_text(file_id),)
257
yield identifier, cur_file
259
def get_symlink_target(self, file_id):
260
"""Get the target for a given file_id.
262
It is assumed that the caller already knows that file_id is referencing
264
:param file_id: Handle for the symlink entry.
265
:return: The path the symlink points to.
267
raise NotImplementedError(self.get_symlink_target)
269
def annotate_iter(self, file_id):
270
"""Return an iterator of revision_id, line tuples
272
For working trees (and mutable trees in general), the special
273
revision_id 'current:' will be used for lines that are new in this
274
tree, e.g. uncommitted changes.
275
:param file_id: The file to produce an annotated version from
277
raise NotImplementedError(self.annotate_iter)
279
def plan_file_merge(self, file_id, other):
280
"""Generate a merge plan based on annotations
282
If the file contains uncommitted changes in this tree, they will be
283
attributed to the 'current:' pseudo-revision. If the file contains
284
uncommitted changes in the other tree, they will be assigned to the
285
'other:' pseudo-revision.
287
from bzrlib import merge
288
annotated_a = list(self.annotate_iter(file_id,
289
_mod_revision.CURRENT_REVISION))
290
annotated_b = list(other.annotate_iter(file_id, 'other:'))
291
ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
292
ancestors_b = other._get_ancestors('other:')
293
return merge._plan_annotate_merge(annotated_a, annotated_b,
294
ancestors_a, ancestors_b)
80
296
inventory = property(_get_inventory,
81
297
doc="Inventory of this Tree")
99
315
"file is actually %s" % fp['sha1'],
100
316
"store is probably damaged/corrupt"])
319
def path2id(self, path):
320
"""Return the id for path in this tree."""
321
return self._inventory.path2id(path)
323
def paths2ids(self, paths, trees=[], require_versioned=True):
324
"""Return all the ids that can be reached by walking from paths.
326
Each path is looked up in each this tree and any extras provided in
327
trees, and this is repeated recursively: the children in an extra tree
328
of a directory that has been renamed under a provided path in this tree
329
are all returned, even if none exist until a provided path in this
330
tree, and vice versa.
332
:param paths: An iterable of paths to start converting to ids from.
333
Alternatively, if paths is None, no ids should be calculated and None
334
will be returned. This is offered to make calling the api unconditional
335
for code that *might* take a list of files.
336
:param trees: Additional trees to consider.
337
:param require_versioned: If False, do not raise NotVersionedError if
338
an element of paths is not versioned in this tree and all of trees.
340
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
103
342
def print_file(self, file_id):
104
343
"""Print file with id `file_id` to stdout."""
344
file_id = osutils.safe_file_id(file_id)
106
346
sys.stdout.write(self.get_file_text(file_id))
109
class RevisionTree(Tree):
110
"""Tree viewing a previous revision.
112
File text can be retrieved from the text store.
114
TODO: Some kind of `__repr__` method, but a good one
115
probably means knowing the branch and revision number,
116
or at least passing a description to the constructor.
119
def __init__(self, branch, inv, revision_id):
120
self._branch = branch
121
self._weave_store = branch.weave_store
122
self._inventory = inv
123
self._revision_id = revision_id
125
def get_weave(self, file_id):
126
import bzrlib.transactions as transactions
127
return self._weave_store.get_weave(file_id,
128
self._branch.get_transaction())
130
def get_weave_prelude(self, file_id):
131
import bzrlib.transactions as transactions
132
return self._weave_store.get_weave_prelude(file_id,
133
self._branch.get_transaction())
135
def get_file_lines(self, file_id):
136
ie = self._inventory[file_id]
137
weave = self.get_weave(file_id)
138
return weave.get(ie.revision)
140
def get_file_text(self, file_id):
141
return ''.join(self.get_file_lines(file_id))
143
def get_file(self, file_id):
144
return StringIO(self.get_file_text(file_id))
146
def get_file_size(self, file_id):
147
return self._inventory[file_id].text_size
149
def get_file_sha1(self, file_id):
150
ie = self._inventory[file_id]
151
if ie.kind == "file":
154
def is_executable(self, file_id):
155
ie = self._inventory[file_id]
156
if ie.kind != "file":
158
return self._inventory[file_id].executable
160
def has_filename(self, filename):
161
return bool(self.inventory.path2id(filename))
163
def list_files(self):
164
# The only files returned by this are those from the version
165
for path, entry in self.inventory.iter_entries():
166
yield path, 'V', entry.kind, entry.file_id, entry
168
def get_symlink_target(self, file_id):
169
ie = self._inventory[file_id]
170
return ie.symlink_target;
172
def kind(self, file_id):
173
return self._inventory[file_id].kind
351
def revision_tree(self, revision_id):
352
"""Obtain a revision tree for the revision revision_id.
354
The intention of this method is to allow access to possibly cached
355
tree data. Implementors of this method should raise NoSuchRevision if
356
the tree is not locally available, even if they could obtain the
357
tree via a repository or some other means. Callers are responsible
358
for finding the ultimate source for a revision tree.
360
:param revision_id: The revision_id of the requested tree.
362
:raises: NoSuchRevision if the tree cannot be obtained.
364
raise errors.NoSuchRevisionInTree(self, revision_id)
367
"""What files are present in this tree and unknown.
369
:return: an iterator over the unknown files.
376
def filter_unversioned_files(self, paths):
377
"""Filter out paths that are versioned.
379
:return: set of paths.
381
# NB: we specifically *don't* call self.has_filename, because for
382
# WorkingTrees that can indicate files that exist on disk but that
384
pred = self.inventory.has_filename
385
return set((p for p in paths if not pred(p)))
387
def walkdirs(self, prefix=""):
388
"""Walk the contents of this tree from path down.
390
This yields all the data about the contents of a directory at a time.
391
After each directory has been yielded, if the caller has mutated the
392
list to exclude some directories, they are then not descended into.
394
The data yielded is of the form:
395
((directory-relpath, directory-path-from-root, directory-fileid),
396
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
397
versioned_kind), ...]),
398
- directory-relpath is the containing dirs relpath from prefix
399
- directory-path-from-root is the containing dirs path from /
400
- directory-fileid is the id of the directory if it is versioned.
401
- relpath is the relative path within the subtree being walked.
402
- basename is the basename
403
- kind is the kind of the file now. If unknonwn then the file is not
404
present within the tree - but it may be recorded as versioned. See
406
- lstat is the stat data *if* the file was statted.
407
- path_from_tree_root is the path from the root of the tree.
408
- file_id is the file_id is the entry is versioned.
409
- versioned_kind is the kind of the file as last recorded in the
410
versioning system. If 'unknown' the file is not versioned.
411
One of 'kind' and 'versioned_kind' must not be 'unknown'.
413
:param prefix: Start walking from prefix within the tree rather than
414
at the root. This allows one to walk a subtree but get paths that are
415
relative to a tree rooted higher up.
416
:return: an iterator over the directory data.
418
raise NotImplementedError(self.walkdirs)
176
421
class EmptyTree(Tree):
177
423
def __init__(self):
178
self._inventory = Inventory()
424
self._inventory = Inventory(root_id=None)
425
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
426
' use repository.revision_tree instead.',
427
DeprecationWarning, stacklevel=2)
429
def get_parent_ids(self):
180
432
def get_symlink_target(self, file_id):
263
516
yield (old_name, new_name)
519
def find_ids_across_trees(filenames, trees, require_versioned=True):
520
"""Find the ids corresponding to specified filenames.
522
All matches in all trees will be used, and all children of matched
523
directories will be used.
525
:param filenames: The filenames to find file_ids for (if None, returns
527
:param trees: The trees to find file_ids within
528
:param require_versioned: if true, all specified filenames must occur in
530
:return: a set of file ids for the specified filenames and their children.
534
specified_path_ids = _find_ids_across_trees(filenames, trees,
536
return _find_children_across_trees(specified_path_ids, trees)
539
def _find_ids_across_trees(filenames, trees, require_versioned):
540
"""Find the ids corresponding to specified filenames.
542
All matches in all trees will be used, but subdirectories are not scanned.
544
:param filenames: The filenames to find file_ids for
545
:param trees: The trees to find file_ids within
546
:param require_versioned: if true, all specified filenames must occur in
548
:return: a set of (path, file ids) for the specified filenames
551
interesting_ids = set()
552
for tree_path in filenames:
555
file_id = tree.path2id(tree_path)
556
if file_id is not None:
557
interesting_ids.add(file_id)
560
not_versioned.append(tree_path)
561
if len(not_versioned) > 0 and require_versioned:
562
raise errors.PathsNotVersionedError(not_versioned)
563
return interesting_ids
566
def _find_children_across_trees(specified_ids, trees):
567
"""Return a set including specified ids and their children
569
All matches in all trees will be used.
571
:param trees: The trees to find file_ids within
572
:return: a set containing all specified ids and their children
574
interesting_ids = set(specified_ids)
575
pending = interesting_ids
576
# now handle children of interesting ids
577
# we loop so that we handle all children of each id in both trees
578
while len(pending) > 0:
580
for file_id in pending:
582
if not tree.has_id(file_id):
584
entry = tree.inventory[file_id]
585
for child in getattr(entry, 'children', {}).itervalues():
586
if child.file_id not in interesting_ids:
587
new_pending.add(child.file_id)
588
interesting_ids.update(new_pending)
589
pending = new_pending
590
return interesting_ids
593
class InterTree(InterObject):
594
"""This class represents operations taking place between two Trees.
596
Its instances have methods like 'compare' and contain references to the
597
source and target trees these operations are to be carried out on.
599
clients of bzrlib should not need to use InterTree directly, rather they
600
should use the convenience methods on Tree such as 'Tree.compare()' which
601
will pass through to InterTree as appropriate.
607
def compare(self, want_unchanged=False, specific_files=None,
608
extra_trees=None, require_versioned=False, include_root=False,
609
want_unversioned=False):
610
"""Return the changes from source to target.
612
:return: A TreeDelta.
613
:param specific_files: An optional list of file paths to restrict the
614
comparison to. When mapping filenames to ids, all matches in all
615
trees (including optional extra_trees) are used, and all children of
616
matched directories are included.
617
:param want_unchanged: An optional boolean requesting the inclusion of
618
unchanged entries in the result.
619
:param extra_trees: An optional list of additional trees to use when
620
mapping the contents of specific_files (paths) to file_ids.
621
:param require_versioned: An optional boolean (defaults to False). When
622
supplied and True all the 'specific_files' must be versioned, or
623
a PathsNotVersionedError will be thrown.
624
:param want_unversioned: Scan for unversioned paths.
626
# NB: show_status depends on being able to pass in non-versioned files
627
# and report them as unknown
628
trees = (self.source,)
629
if extra_trees is not None:
630
trees = trees + tuple(extra_trees)
631
# target is usually the newer tree:
632
specific_file_ids = self.target.paths2ids(specific_files, trees,
633
require_versioned=require_versioned)
634
if specific_files and not specific_file_ids:
635
# All files are unversioned, so just return an empty delta
636
# _compare_trees would think we want a complete delta
637
result = delta.TreeDelta()
638
fake_entry = InventoryFile('unused', 'unused', 'unused')
639
result.unversioned = [(path, None,
640
self.target._comparison_data(fake_entry, path)[0]) for path in
643
return delta._compare_trees(self.source, self.target, want_unchanged,
644
specific_files, include_root, extra_trees=extra_trees,
645
require_versioned=require_versioned,
646
want_unversioned=want_unversioned)
648
def _iter_changes(self, include_unchanged=False,
649
specific_files=None, pb=None, extra_trees=[],
650
require_versioned=True, want_unversioned=False):
651
"""Generate an iterator of changes between trees.
654
(file_id, (path_in_source, path_in_target),
655
changed_content, versioned, parent, name, kind,
658
Changed_content is True if the file's content has changed. This
659
includes changes to its kind, and to a symlink's target.
661
versioned, parent, name, kind, executable are tuples of (from, to).
662
If a file is missing in a tree, its kind is None.
664
Iteration is done in parent-to-child order, relative to the target
667
There is no guarantee that all paths are in sorted order: the
668
requirement to expand the search due to renames may result in children
669
that should be found early being found late in the search, after
670
lexically later results have been returned.
671
:param require_versioned: Raise errors.PathsNotVersionedError if a
672
path in the specific_files list is not versioned in one of
673
source, target or extra_trees.
674
:param want_unversioned: Should unversioned files be returned in the
675
output. An unversioned file is defined as one with (False, False)
676
for the versioned pair.
679
lookup_trees = [self.source]
681
lookup_trees.extend(extra_trees)
682
if specific_files == []:
683
specific_file_ids = []
685
specific_file_ids = self.target.paths2ids(specific_files,
686
lookup_trees, require_versioned=require_versioned)
688
all_unversioned = sorted([(p.split('/'), p) for p in
690
if specific_files is None or
691
osutils.is_inside_any(specific_files, p)])
692
all_unversioned = deque(all_unversioned)
694
all_unversioned = deque()
696
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
697
specific_file_ids=specific_file_ids))
698
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
699
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
700
specific_file_ids=specific_file_ids))
701
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
703
# the unversioned path lookup only occurs on real trees - where there
704
# can be extras. So the fake_entry is solely used to look up
705
# executable it values when execute is not supported.
706
fake_entry = InventoryFile('unused', 'unused', 'unused')
707
for to_path, to_entry in to_entries_by_dir:
708
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
709
unversioned_path = all_unversioned.popleft()
710
to_kind, to_executable, to_stat = \
711
self.target._comparison_data(fake_entry, unversioned_path[1])
712
yield (None, (None, unversioned_path[1]), True, (False, False),
714
(None, unversioned_path[0][-1]),
716
(None, to_executable))
717
file_id = to_entry.file_id
718
to_paths[file_id] = to_path
720
changed_content = False
721
from_path, from_entry = from_data.get(file_id, (None, None))
722
from_versioned = (from_entry is not None)
723
if from_entry is not None:
724
from_versioned = True
725
from_name = from_entry.name
726
from_parent = from_entry.parent_id
727
from_kind, from_executable, from_stat = \
728
self.source._comparison_data(from_entry, from_path)
731
from_versioned = False
735
from_executable = None
736
versioned = (from_versioned, True)
737
to_kind, to_executable, to_stat = \
738
self.target._comparison_data(to_entry, to_path)
739
kind = (from_kind, to_kind)
740
if kind[0] != kind[1]:
741
changed_content = True
742
elif from_kind == 'file':
743
from_size = self.source._file_size(from_entry, from_stat)
744
to_size = self.target._file_size(to_entry, to_stat)
745
if from_size != to_size:
746
changed_content = True
747
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
748
self.target.get_file_sha1(file_id, to_path, to_stat)):
749
changed_content = True
750
elif from_kind == 'symlink':
751
if (self.source.get_symlink_target(file_id) !=
752
self.target.get_symlink_target(file_id)):
753
changed_content = True
754
elif from_kind == 'tree-reference':
755
if (self.source.get_reference_revision(file_id, from_path)
756
!= self.target.get_reference_revision(file_id, to_path)):
757
changed_content = True
758
parent = (from_parent, to_entry.parent_id)
759
name = (from_name, to_entry.name)
760
executable = (from_executable, to_executable)
762
pb.update('comparing files', entry_count, num_entries)
763
if (changed_content is not False or versioned[0] != versioned[1]
764
or parent[0] != parent[1] or name[0] != name[1] or
765
executable[0] != executable[1] or include_unchanged):
766
yield (file_id, (from_path, to_path), changed_content,
767
versioned, parent, name, kind, executable)
769
while all_unversioned:
770
# yield any trailing unversioned paths
771
unversioned_path = all_unversioned.popleft()
772
to_kind, to_executable, to_stat = \
773
self.target._comparison_data(fake_entry, unversioned_path[1])
774
yield (None, (None, unversioned_path[1]), True, (False, False),
776
(None, unversioned_path[0][-1]),
778
(None, to_executable))
780
def get_to_path(to_entry):
781
if to_entry.parent_id is None:
782
to_path = '' # the root
784
if to_entry.parent_id not in to_paths:
786
return get_to_path(self.target.inventory[to_entry.parent_id])
787
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
789
to_paths[to_entry.file_id] = to_path
792
for path, from_entry in from_entries_by_dir:
793
file_id = from_entry.file_id
794
if file_id in to_paths:
797
if not file_id in self.target.inventory:
798
# common case - paths we have not emitted are not present in
802
to_path = get_to_path(self.target.inventory[file_id])
805
pb.update('comparing files', entry_count, num_entries)
806
versioned = (True, False)
807
parent = (from_entry.parent_id, None)
808
name = (from_entry.name, None)
809
from_kind, from_executable, stat_value = \
810
self.source._comparison_data(from_entry, path)
811
kind = (from_kind, None)
812
executable = (from_executable, None)
813
changed_content = True
814
# the parent's path is necessarily known at this point.
815
yield(file_id, (path, to_path), changed_content, versioned, parent,
816
name, kind, executable)
819
# This was deprecated before 0.12, but did not have an official warning
820
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
821
def RevisionTree(*args, **kwargs):
822
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
824
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
827
from bzrlib.revisiontree import RevisionTree as _RevisionTree
828
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
