198
180
down to specific_file_ids that have been requested. This has no
199
181
impact if specific_file_ids is None.
201
return self.inventory.iter_entries_by_dir(
202
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)
204
196
def iter_references(self):
205
197
if self.supports_tree_reference():
363
370
raise NotImplementedError(self.get_symlink_target)
365
def get_canonical_inventory_paths(self, paths):
366
"""Like get_canonical_inventory_path() but works on multiple items.
368
:param paths: A sequence of paths relative to the root of the tree.
369
:return: A list of paths, with each item the corresponding input path
370
adjusted to account for existing elements that match case
373
return list(self._yield_canonical_inventory_paths(paths))
375
def get_canonical_inventory_path(self, path):
376
"""Returns the first inventory item that case-insensitively matches path.
378
If a path matches exactly, it is returned. If no path matches exactly
379
but more than one path matches case-insensitively, it is implementation
380
defined which is returned.
382
If no path matches case-insensitively, the input path is returned, but
383
with as many path entries that do exist changed to their canonical
386
If you need to resolve many names from the same tree, you should
387
use get_canonical_inventory_paths() to avoid O(N) behaviour.
389
:param path: A paths relative to the root of the tree.
390
:return: The input path adjusted to account for existing elements
391
that match case insensitively.
393
return self._yield_canonical_inventory_paths([path]).next()
395
def _yield_canonical_inventory_paths(self, paths):
397
# First, if the path as specified exists exactly, just use it.
398
if self.path2id(path) is not None:
402
cur_id = self.get_root_id()
404
bit_iter = iter(path.split("/"))
408
for child in self.iter_children(cur_id):
410
# XXX: it seem like if the child is known to be in the
411
# tree, we shouldn't need to go from its id back to
412
# its path -- mbp 2010-02-11
414
# XXX: it seems like we could be more efficient
415
# by just directly looking up the original name and
416
# only then searching all children; also by not
417
# chopping paths so much. -- mbp 2010-02-11
418
child_base = os.path.basename(self.id2path(child))
419
if (child_base == elt):
420
# if we found an exact match, we can stop now; if
421
# we found an approximate match we need to keep
422
# searching because there might be an exact match
425
new_path = osutils.pathjoin(cur_path, child_base)
427
elif child_base.lower() == lelt:
429
new_path = osutils.pathjoin(cur_path, child_base)
431
# before a change is committed we can see this error...
436
# got to the end of this directory and no entries matched.
437
# Return what matched so far, plus the rest as specified.
438
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
443
373
def get_root_id(self):
444
374
"""Return the file_id for the root of this tree."""
530
461
vf.fallback_versionedfiles.append(base_vf)
531
462
return last_revision
533
inventory = property(_get_inventory,
534
doc="Inventory of this Tree")
536
464
def _check_retrieved(self, ie, f):
537
465
if not __debug__:
539
fp = fingerprint_file(f)
467
fp = osutils.fingerprint_file(f)
542
470
if ie.text_size is not None:
543
471
if ie.text_size != fp['size']:
544
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
472
raise errors.BzrError(
473
"mismatched size for file %r in %r" %
474
(ie.file_id, self._store),
545
475
["inventory expects %d bytes" % ie.text_size,
546
476
"file is actually %d bytes" % fp['size'],
547
477
"store is probably damaged/corrupt"])
549
479
if ie.text_sha1 != fp['sha1']:
550
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
480
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
481
(ie.file_id, self._store),
551
482
["inventory expects %s" % ie.text_sha1,
552
483
"file is actually %s" % fp['sha1'],
553
484
"store is probably damaged/corrupt"])
556
486
def path2id(self, path):
557
487
"""Return the id for path in this tree."""
558
return self._inventory.path2id(path)
488
raise NotImplementedError(self.path2id)
560
490
def paths2ids(self, paths, trees=[], require_versioned=True):
561
491
"""Return all the ids that can be reached by walking from paths.
654
class InventoryTree(Tree):
655
"""A tree that relies on an inventory for its metadata.
657
Trees contain an `Inventory` object, and also know how to retrieve
658
file texts mentioned in the inventory, either from a working
659
directory or from a store.
661
It is possible for trees to contain files that are not described
662
in their inventory or vice versa; for this use `filenames()`.
664
Subclasses should set the _inventory attribute, which is considered
665
private to external API users.
668
def get_canonical_inventory_paths(self, paths):
669
"""Like get_canonical_inventory_path() but works on multiple items.
671
:param paths: A sequence of paths relative to the root of the tree.
672
:return: A list of paths, with each item the corresponding input path
673
adjusted to account for existing elements that match case
676
return list(self._yield_canonical_inventory_paths(paths))
678
def get_canonical_inventory_path(self, path):
679
"""Returns the first inventory item that case-insensitively matches path.
681
If a path matches exactly, it is returned. If no path matches exactly
682
but more than one path matches case-insensitively, it is implementation
683
defined which is returned.
685
If no path matches case-insensitively, the input path is returned, but
686
with as many path entries that do exist changed to their canonical
689
If you need to resolve many names from the same tree, you should
690
use get_canonical_inventory_paths() to avoid O(N) behaviour.
692
:param path: A paths relative to the root of the tree.
693
:return: The input path adjusted to account for existing elements
694
that match case insensitively.
696
return self._yield_canonical_inventory_paths([path]).next()
698
def _yield_canonical_inventory_paths(self, paths):
700
# First, if the path as specified exists exactly, just use it.
701
if self.path2id(path) is not None:
705
cur_id = self.get_root_id()
707
bit_iter = iter(path.split("/"))
711
for child in self.iter_children(cur_id):
713
# XXX: it seem like if the child is known to be in the
714
# tree, we shouldn't need to go from its id back to
715
# its path -- mbp 2010-02-11
717
# XXX: it seems like we could be more efficient
718
# by just directly looking up the original name and
719
# only then searching all children; also by not
720
# chopping paths so much. -- mbp 2010-02-11
721
child_base = os.path.basename(self.id2path(child))
722
if (child_base == elt):
723
# if we found an exact match, we can stop now; if
724
# we found an approximate match we need to keep
725
# searching because there might be an exact match
728
new_path = osutils.pathjoin(cur_path, child_base)
730
elif child_base.lower() == lelt:
732
new_path = osutils.pathjoin(cur_path, child_base)
733
except errors.NoSuchId:
734
# before a change is committed we can see this error...
739
# got to the end of this directory and no entries matched.
740
# Return what matched so far, plus the rest as specified.
741
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
746
def _get_inventory(self):
747
return self._inventory
749
inventory = property(_get_inventory,
750
doc="Inventory of this Tree")
753
def path2id(self, path):
754
"""Return the id for path in this tree."""
755
return self._inventory.path2id(path)
757
def id2path(self, file_id):
758
"""Return the path for a file id.
762
return self.inventory.id2path(file_id)
764
def has_id(self, file_id):
765
return self.inventory.has_id(file_id)
767
def has_or_had_id(self, file_id):
768
return self.inventory.has_id(file_id)
771
return iter(self.inventory)
773
def filter_unversioned_files(self, paths):
774
"""Filter out paths that are versioned.
776
:return: set of paths.
778
# NB: we specifically *don't* call self.has_filename, because for
779
# WorkingTrees that can indicate files that exist on disk but that
781
pred = self.inventory.has_filename
782
return set((p for p in paths if not pred(p)))
785
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
786
"""Walk the tree in 'by_dir' order.
788
This will yield each entry in the tree as a (path, entry) tuple.
789
The order that they are yielded is:
791
See Tree.iter_entries_by_dir for details.
793
:param yield_parents: If True, yield the parents from the root leading
794
down to specific_file_ids that have been requested. This has no
795
impact if specific_file_ids is None.
797
return self.inventory.iter_entries_by_dir(
798
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
800
def get_file_by_path(self, path):
801
return self.get_file(self._inventory.path2id(path), path)
728
804
######################################################################
added
removed
bzrlib/tree.py
