127
174
preceeded by the parent of a directory, and all the contents of a
128
175
directory are grouped together.
130
return self.inventory.iter_entries_by_dir()
177
return self.inventory.iter_entries_by_dir(
178
specific_file_ids=specific_file_ids)
180
def iter_references(self):
181
for path, entry in self.iter_entries_by_dir():
182
if entry.kind == 'tree-reference':
183
yield path, entry.file_id
132
185
def kind(self, file_id):
133
raise NotImplementedError("subclasses must implement kind")
186
raise NotImplementedError("Tree subclass %s must implement kind"
187
% self.__class__.__name__)
189
def get_reference_revision(self, file_id, path=None):
190
raise NotImplementedError("Tree subclass %s must implement "
191
"get_reference_revision"
192
% self.__class__.__name__)
194
def _comparison_data(self, entry, path):
195
"""Return a tuple of kind, executable, stat_value for a file.
197
entry may be None if there is no inventory entry for the file, but
198
path must always be supplied.
200
kind is None if there is no file present (even if an inventory id is
201
present). executable is False for non-file entries.
203
raise NotImplementedError(self._comparison_data)
205
def _file_size(self, entry, stat_value):
206
raise NotImplementedError(self._file_size)
135
208
def _get_inventory(self):
136
209
return self._inventory
211
def get_file(self, file_id):
212
"""Return a file object for the file file_id in the tree."""
213
raise NotImplementedError(self.get_file)
215
def get_file_mtime(self, file_id, path=None):
216
"""Return the modification time for a file.
218
:param file_id: The handle for this file.
219
:param path: The path that this file can be found at.
220
These must point to the same object.
222
raise NotImplementedError(self.get_file_mtime)
138
224
def get_file_by_path(self, path):
139
225
return self.get_file(self._inventory.path2id(path))
227
def get_symlink_target(self, file_id):
228
"""Get the target for a given file_id.
230
It is assumed that the caller already knows that file_id is referencing
232
:param file_id: Handle for the symlink entry.
233
:return: The path the symlink points to.
235
raise NotImplementedError(self.get_symlink_target)
237
def annotate_iter(self, file_id):
238
"""Return an iterator of revision_id, line tuples
240
For working trees (and mutable trees in general), the special
241
revision_id 'current:' will be used for lines that are new in this
242
tree, e.g. uncommitted changes.
243
:param file_id: The file to produce an annotated version from
245
raise NotImplementedError(self.annotate_iter)
141
247
inventory = property(_get_inventory,
142
248
doc="Inventory of this Tree")
160
266
"file is actually %s" % fp['sha1'],
161
267
"store is probably damaged/corrupt"])
270
def path2id(self, path):
271
"""Return the id for path in this tree."""
272
return self._inventory.path2id(path)
274
def paths2ids(self, paths, trees=[], require_versioned=True):
275
"""Return all the ids that can be reached by walking from paths.
277
Each path is looked up in each this tree and any extras provided in
278
trees, and this is repeated recursively: the children in an extra tree
279
of a directory that has been renamed under a provided path in this tree
280
are all returned, even if none exist until a provided path in this
281
tree, and vice versa.
283
:param paths: An iterable of paths to start converting to ids from.
284
Alternatively, if paths is None, no ids should be calculated and None
285
will be returned. This is offered to make calling the api unconditional
286
for code that *might* take a list of files.
287
:param trees: Additional trees to consider.
288
:param require_versioned: If False, do not raise NotVersionedError if
289
an element of paths is not versioned in this tree and all of trees.
291
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
164
293
def print_file(self, file_id):
165
294
"""Print file with id `file_id` to stdout."""
295
file_id = osutils.safe_file_id(file_id)
167
297
sys.stdout.write(self.get_file_text(file_id))
169
299
def lock_read(self):
302
def revision_tree(self, revision_id):
303
"""Obtain a revision tree for the revision revision_id.
305
The intention of this method is to allow access to possibly cached
306
tree data. Implementors of this method should raise NoSuchRevision if
307
the tree is not locally available, even if they could obtain the
308
tree via a repository or some other means. Callers are responsible
309
for finding the ultimate source for a revision tree.
311
:param revision_id: The revision_id of the requested tree.
313
:raises: NoSuchRevision if the tree cannot be obtained.
315
raise errors.NoSuchRevisionInTree(self, revision_id)
172
317
def unknowns(self):
173
318
"""What files are present in this tree and unknown.
190
335
pred = self.inventory.has_filename
191
336
return set((p for p in paths if not pred(p)))
195
from bzrlib.revisiontree import RevisionTree
338
def walkdirs(self, prefix=""):
339
"""Walk the contents of this tree from path down.
341
This yields all the data about the contents of a directory at a time.
342
After each directory has been yielded, if the caller has mutated the
343
list to exclude some directories, they are then not descended into.
345
The data yielded is of the form:
346
((directory-relpath, directory-path-from-root, directory-fileid),
347
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
348
versioned_kind), ...]),
349
- directory-relpath is the containing dirs relpath from prefix
350
- directory-path-from-root is the containing dirs path from /
351
- directory-fileid is the id of the directory if it is versioned.
352
- relpath is the relative path within the subtree being walked.
353
- basename is the basename
354
- kind is the kind of the file now. If unknonwn then the file is not
355
present within the tree - but it may be recorded as versioned. See
357
- lstat is the stat data *if* the file was statted.
358
- path_from_tree_root is the path from the root of the tree.
359
- file_id is the file_id is the entry is versioned.
360
- versioned_kind is the kind of the file as last recorded in the
361
versioning system. If 'unknown' the file is not versioned.
362
One of 'kind' and 'versioned_kind' must not be 'unknown'.
364
:param prefix: Start walking from prefix within the tree rather than
365
at the root. This allows one to walk a subtree but get paths that are
366
relative to a tree rooted higher up.
367
:return: an iterator over the directory data.
369
raise NotImplementedError(self.walkdirs)
198
372
class EmptyTree(Tree):
200
374
def __init__(self):
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)
375
self._inventory = Inventory(root_id=None)
376
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
377
' use repository.revision_tree instead.',
378
DeprecationWarning, stacklevel=2)
206
380
def get_parent_ids(self):
394
572
:param require_versioned: An optional boolean (defaults to False). When
395
573
supplied and True all the 'specific_files' must be versioned, or
396
574
a PathsNotVersionedError will be thrown.
575
:param want_unversioned: Scan for unversioned paths.
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)
577
# NB: show_status depends on being able to pass in non-versioned files
578
# and report them as unknown
579
trees = (self.source,)
401
580
if extra_trees is not None:
402
581
trees = trees + tuple(extra_trees)
403
specific_file_ids = find_ids_across_trees(specific_files,
404
trees, require_versioned=require_versioned)
582
# target is usually the newer tree:
583
specific_file_ids = self.target.paths2ids(specific_files, trees,
584
require_versioned=require_versioned)
405
585
if specific_files and not specific_file_ids:
406
586
# All files are unversioned, so just return an empty delta
407
587
# _compare_trees would think we want a complete delta
408
return delta.TreeDelta()
588
result = delta.TreeDelta()
589
fake_entry = InventoryFile('unused', 'unused', 'unused')
590
result.unversioned = [(path, None,
591
self.target._comparison_data(fake_entry, path)[0]) for path in
409
594
return delta._compare_trees(self.source, self.target, want_unchanged,
595
specific_files, include_root, extra_trees=extra_trees,
596
want_unversioned=want_unversioned)
598
def _iter_changes(self, include_unchanged=False,
599
specific_files=None, pb=None, extra_trees=[],
600
require_versioned=True, want_unversioned=False):
601
"""Generate an iterator of changes between trees.
604
(file_id, (path_in_source, path_in_target),
605
changed_content, versioned, parent, name, kind,
608
Changed_content is True if the file's content has changed. This
609
includes changes to its kind, and to a symlink's target.
611
versioned, parent, name, kind, executable are tuples of (from, to).
612
If a file is missing in a tree, its kind is None.
614
Iteration is done in parent-to-child order, relative to the target
617
There is no guarantee that all paths are in sorted order: the
618
requirement to expand the search due to renames may result in children
619
that should be found early being found late in the search, after
620
lexically later results have been returned.
621
:param require_versioned: Raise errors.PathsNotVersionedError if a
622
path in the specific_files list is not versioned in one of
623
source, target or extra_trees.
624
:param want_unversioned: Should unversioned files be returned in the
625
output. An unversioned file is defined as one with (False, False)
626
for the versioned pair.
629
lookup_trees = [self.source]
631
lookup_trees.extend(extra_trees)
632
specific_file_ids = self.target.paths2ids(specific_files,
633
lookup_trees, require_versioned=require_versioned)
635
all_unversioned = sorted([(p.split('/'), p) for p in self.target.extras()
636
if not specific_files or
637
osutils.is_inside_any(specific_files, p)])
638
all_unversioned = deque(all_unversioned)
640
all_unversioned = deque()
642
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
643
specific_file_ids=specific_file_ids))
644
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
645
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
646
specific_file_ids=specific_file_ids))
647
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
649
# the unversioned path lookup only occurs on real trees - where there
650
# can be extras. So the fake_entry is solely used to look up
651
# executable it values when execute is not supported.
652
fake_entry = InventoryFile('unused', 'unused', 'unused')
653
for to_path, to_entry in to_entries_by_dir:
654
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
655
unversioned_path = all_unversioned.popleft()
656
to_kind, to_executable, to_stat = \
657
self.target._comparison_data(fake_entry, unversioned_path[1])
658
yield (None, (None, unversioned_path[1]), True, (False, False),
660
(None, unversioned_path[0][-1]),
662
(None, to_executable))
663
file_id = to_entry.file_id
664
to_paths[file_id] = to_path
666
changed_content = False
667
from_path, from_entry = from_data.get(file_id, (None, None))
668
from_versioned = (from_entry is not None)
669
if from_entry is not None:
670
from_versioned = True
671
from_name = from_entry.name
672
from_parent = from_entry.parent_id
673
from_kind, from_executable, from_stat = \
674
self.source._comparison_data(from_entry, from_path)
677
from_versioned = False
681
from_executable = None
682
versioned = (from_versioned, True)
683
to_kind, to_executable, to_stat = \
684
self.target._comparison_data(to_entry, to_path)
685
kind = (from_kind, to_kind)
686
if kind[0] != kind[1]:
687
changed_content = True
688
elif from_kind == 'file':
689
from_size = self.source._file_size(from_entry, from_stat)
690
to_size = self.target._file_size(to_entry, to_stat)
691
if from_size != to_size:
692
changed_content = True
693
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
694
self.target.get_file_sha1(file_id, to_path, to_stat)):
695
changed_content = True
696
elif from_kind == 'symlink':
697
if (self.source.get_symlink_target(file_id) !=
698
self.target.get_symlink_target(file_id)):
699
changed_content = True
700
elif from_kind == 'tree-reference':
701
if (self.source.get_reference_revision(file_id, from_path)
702
!= self.target.get_reference_revision(file_id, to_path)):
703
changed_content = True
704
parent = (from_parent, to_entry.parent_id)
705
name = (from_name, to_entry.name)
706
executable = (from_executable, to_executable)
708
pb.update('comparing files', entry_count, num_entries)
709
if (changed_content is not False or versioned[0] != versioned[1]
710
or parent[0] != parent[1] or name[0] != name[1] or
711
executable[0] != executable[1] or include_unchanged):
712
yield (file_id, (from_path, to_path), changed_content,
713
versioned, parent, name, kind, executable)
715
while all_unversioned:
716
# yield any trailing unversioned paths
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))
726
def get_to_path(to_entry):
727
if to_entry.parent_id is None:
728
to_path = '' # the root
730
if to_entry.parent_id not in to_paths:
732
return get_to_path(self.target.inventory[to_entry.parent_id])
733
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
735
to_paths[to_entry.file_id] = to_path
738
for path, from_entry in from_entries_by_dir:
739
file_id = from_entry.file_id
740
if file_id in to_paths:
743
if not file_id in self.target.inventory:
744
# common case - paths we have not emitted are not present in
748
to_path = get_to_path(self.target.inventory[file_id])
751
pb.update('comparing files', entry_count, num_entries)
752
versioned = (True, False)
753
parent = (from_entry.parent_id, None)
754
name = (from_entry.name, None)
755
from_kind, from_executable, stat_value = \
756
self.source._comparison_data(from_entry, path)
757
kind = (from_kind, None)
758
executable = (from_executable, None)
759
changed_content = True
760
# the parent's path is necessarily known at this point.
761
yield(file_id, (path, to_path), changed_content, versioned, parent,
762
name, kind, executable)
765
# This was deprecated before 0.12, but did not have an official warning
766
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
767
def RevisionTree(*args, **kwargs):
768
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
770
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
773
from bzrlib.revisiontree import RevisionTree as _RevisionTree
774
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
