186
180
down to specific_file_ids that have been requested. This has no
187
181
impact if specific_file_ids is None.
189
return self.inventory.iter_entries_by_dir(
190
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
183
raise NotImplementedError(self.iter_entries_by_dir)
185
def list_files(self, include_root=False, from_dir=None, recursive=True):
186
"""List all files in this tree.
188
:param include_root: Whether to include the entry for the tree root
189
:param from_dir: Directory under which to list files
190
:param recursive: Whether to list files recursively
191
:return: iterator over tuples of (path, versioned, kind, file_id,
194
raise NotImplementedError(self.list_files)
192
196
def iter_references(self):
193
197
if self.supports_tree_reference():
351
370
raise NotImplementedError(self.get_symlink_target)
353
def get_canonical_inventory_paths(self, paths):
354
"""Like get_canonical_inventory_path() but works on multiple items.
356
:param paths: A sequence of paths relative to the root of the tree.
357
:return: A list of paths, with each item the corresponding input path
358
adjusted to account for existing elements that match case
361
return list(self._yield_canonical_inventory_paths(paths))
363
def get_canonical_inventory_path(self, path):
364
"""Returns the first inventory item that case-insensitively matches path.
366
If a path matches exactly, it is returned. If no path matches exactly
367
but more than one path matches case-insensitively, it is implementation
368
defined which is returned.
370
If no path matches case-insensitively, the input path is returned, but
371
with as many path entries that do exist changed to their canonical
374
If you need to resolve many names from the same tree, you should
375
use get_canonical_inventory_paths() to avoid O(N) behaviour.
377
:param path: A paths relative to the root of the tree.
378
:return: The input path adjusted to account for existing elements
379
that match case insensitively.
381
return self._yield_canonical_inventory_paths([path]).next()
383
def _yield_canonical_inventory_paths(self, paths):
385
# First, if the path as specified exists exactly, just use it.
386
if self.path2id(path) is not None:
390
cur_id = self.get_root_id()
392
bit_iter = iter(path.split("/"))
396
for child in self.iter_children(cur_id):
398
# XXX: it seem like if the child is known to be in the
399
# tree, we shouldn't need to go from its id back to
400
# its path -- mbp 2010-02-11
402
# XXX: it seems like we could be more efficient
403
# by just directly looking up the original name and
404
# only then searching all children; also by not
405
# chopping paths so much. -- mbp 2010-02-11
406
child_base = os.path.basename(self.id2path(child))
407
if (child_base == elt):
408
# if we found an exact match, we can stop now; if
409
# we found an approximate match we need to keep
410
# searching because there might be an exact match
413
new_path = osutils.pathjoin(cur_path, child_base)
415
elif child_base.lower() == lelt:
417
new_path = osutils.pathjoin(cur_path, child_base)
419
# before a change is committed we can see this error...
424
# got to the end of this directory and no entries matched.
425
# Return what matched so far, plus the rest as specified.
426
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
431
373
def get_root_id(self):
432
374
"""Return the file_id for the root of this tree."""
491
433
except errors.NoSuchRevisionInTree:
492
434
yield self.repository.revision_tree(revision_id)
495
def _file_revision(revision_tree, file_id):
496
"""Determine the revision associated with a file in a given tree."""
497
revision_tree.lock_read()
499
return revision_tree.inventory[file_id].revision
501
revision_tree.unlock()
503
436
def _get_file_revision(self, file_id, vf, tree_revision):
504
437
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
506
439
if getattr(self, '_repository', None) is None:
507
440
last_revision = tree_revision
508
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
441
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
509
442
self._iter_parent_trees()]
510
443
vf.add_lines((file_id, last_revision), parent_keys,
511
444
self.get_file_lines(file_id))
512
445
repo = self.branch.repository
513
446
base_vf = repo.texts
515
last_revision = self._file_revision(self, file_id)
448
last_revision = self.get_file_revision(file_id)
516
449
base_vf = self._repository.texts
517
450
if base_vf not in vf.fallback_versionedfiles:
518
451
vf.fallback_versionedfiles.append(base_vf)
519
452
return last_revision
521
inventory = property(_get_inventory,
522
doc="Inventory of this Tree")
524
454
def _check_retrieved(self, ie, f):
525
455
if not __debug__:
527
fp = fingerprint_file(f)
457
fp = osutils.fingerprint_file(f)
530
460
if ie.text_size is not None:
531
461
if ie.text_size != fp['size']:
532
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
462
raise errors.BzrError(
463
"mismatched size for file %r in %r" %
464
(ie.file_id, self._store),
533
465
["inventory expects %d bytes" % ie.text_size,
534
466
"file is actually %d bytes" % fp['size'],
535
467
"store is probably damaged/corrupt"])
537
469
if ie.text_sha1 != fp['sha1']:
538
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
470
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
471
(ie.file_id, self._store),
539
472
["inventory expects %s" % ie.text_sha1,
540
473
"file is actually %s" % fp['sha1'],
541
474
"store is probably damaged/corrupt"])
544
476
def path2id(self, path):
545
477
"""Return the id for path in this tree."""
546
return self._inventory.path2id(path)
478
raise NotImplementedError(self.path2id)
548
480
def paths2ids(self, paths, trees=[], require_versioned=True):
549
481
"""Return all the ids that can be reached by walking from paths.
644
class InventoryTree(Tree):
645
"""A tree that relies on an inventory for its metadata.
647
Trees contain an `Inventory` object, and also know how to retrieve
648
file texts mentioned in the inventory, either from a working
649
directory or from a store.
651
It is possible for trees to contain files that are not described
652
in their inventory or vice versa; for this use `filenames()`.
654
Subclasses should set the _inventory attribute, which is considered
655
private to external API users.
658
def get_canonical_inventory_paths(self, paths):
659
"""Like get_canonical_inventory_path() but works on multiple items.
661
:param paths: A sequence of paths relative to the root of the tree.
662
:return: A list of paths, with each item the corresponding input path
663
adjusted to account for existing elements that match case
666
return list(self._yield_canonical_inventory_paths(paths))
668
def get_canonical_inventory_path(self, path):
669
"""Returns the first inventory item that case-insensitively matches path.
671
If a path matches exactly, it is returned. If no path matches exactly
672
but more than one path matches case-insensitively, it is implementation
673
defined which is returned.
675
If no path matches case-insensitively, the input path is returned, but
676
with as many path entries that do exist changed to their canonical
679
If you need to resolve many names from the same tree, you should
680
use get_canonical_inventory_paths() to avoid O(N) behaviour.
682
:param path: A paths relative to the root of the tree.
683
:return: The input path adjusted to account for existing elements
684
that match case insensitively.
686
return self._yield_canonical_inventory_paths([path]).next()
688
def _yield_canonical_inventory_paths(self, paths):
690
# First, if the path as specified exists exactly, just use it.
691
if self.path2id(path) is not None:
695
cur_id = self.get_root_id()
697
bit_iter = iter(path.split("/"))
701
for child in self.iter_children(cur_id):
703
# XXX: it seem like if the child is known to be in the
704
# tree, we shouldn't need to go from its id back to
705
# its path -- mbp 2010-02-11
707
# XXX: it seems like we could be more efficient
708
# by just directly looking up the original name and
709
# only then searching all children; also by not
710
# chopping paths so much. -- mbp 2010-02-11
711
child_base = os.path.basename(self.id2path(child))
712
if (child_base == elt):
713
# if we found an exact match, we can stop now; if
714
# we found an approximate match we need to keep
715
# searching because there might be an exact match
718
new_path = osutils.pathjoin(cur_path, child_base)
720
elif child_base.lower() == lelt:
722
new_path = osutils.pathjoin(cur_path, child_base)
723
except errors.NoSuchId:
724
# before a change is committed we can see this error...
729
# got to the end of this directory and no entries matched.
730
# Return what matched so far, plus the rest as specified.
731
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
736
def _get_inventory(self):
737
return self._inventory
739
inventory = property(_get_inventory,
740
doc="Inventory of this Tree")
743
def path2id(self, path):
744
"""Return the id for path in this tree."""
745
return self._inventory.path2id(path)
747
def id2path(self, file_id):
748
"""Return the path for a file id.
752
return self.inventory.id2path(file_id)
754
def has_id(self, file_id):
755
return self.inventory.has_id(file_id)
757
def has_or_had_id(self, file_id):
758
return self.inventory.has_id(file_id)
760
def all_file_ids(self):
761
return set(self.inventory)
763
@deprecated_method(deprecated_in((2, 4, 0)))
765
return iter(self.inventory)
767
def filter_unversioned_files(self, paths):
768
"""Filter out paths that are versioned.
770
:return: set of paths.
772
# NB: we specifically *don't* call self.has_filename, because for
773
# WorkingTrees that can indicate files that exist on disk but that
775
pred = self.inventory.has_filename
776
return set((p for p in paths if not pred(p)))
779
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
780
"""Walk the tree in 'by_dir' order.
782
This will yield each entry in the tree as a (path, entry) tuple.
783
The order that they are yielded is:
785
See Tree.iter_entries_by_dir for details.
787
:param yield_parents: If True, yield the parents from the root leading
788
down to specific_file_ids that have been requested. This has no
789
impact if specific_file_ids is None.
791
return self.inventory.iter_entries_by_dir(
792
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
794
def get_file_by_path(self, path):
795
return self.get_file(self._inventory.path2id(path), path)
716
798
######################################################################
added
removed
bzrlib/tree.py
