147
return iter(self.inventory)
149
144
def all_file_ids(self):
150
145
"""Iterate through all file ids, including ids for missing files."""
151
return set(self.inventory)
146
raise NotImplementedError(self.all_file_ids)
153
148
def id2path(self, file_id):
154
149
"""Return the path for a file id.
156
151
:raises NoSuchId:
158
return self.inventory.id2path(file_id)
160
def is_control_filename(self, filename):
161
"""True if filename is the name of a control file in this tree.
163
:param filename: A filename within the tree. This is a relative path
164
from the root of this tree.
166
This is true IF and ONLY IF the filename is part of the meta data
167
that bzr controls in this tree. I.E. a random .bzr directory placed
168
on disk will not be a control file for this tree.
170
return self.bzrdir.is_control_filename(filename)
153
raise NotImplementedError(self.id2path)
173
155
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
174
156
"""Walk the tree in 'by_dir' order.
194
176
The yield order (ignoring root) would be::
195
178
a, f, a/b, a/d, a/b/c, a/d/e, f/g
197
180
:param yield_parents: If True, yield the parents from the root leading
198
181
down to specific_file_ids that have been requested. This has no
199
182
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)
184
raise NotImplementedError(self.iter_entries_by_dir)
186
def list_files(self, include_root=False, from_dir=None, recursive=True):
187
"""List all files in this tree.
189
:param include_root: Whether to include the entry for the tree root
190
:param from_dir: Directory under which to list files
191
:param recursive: Whether to list files recursively
192
:return: iterator over tuples of (path, versioned, kind, file_id,
195
raise NotImplementedError(self.list_files)
204
197
def iter_references(self):
205
198
if self.supports_tree_reference():
352
361
cur_file = (self.get_file_text(file_id),)
353
362
yield identifier, cur_file
355
def get_symlink_target(self, file_id):
364
def get_symlink_target(self, file_id, path=None):
356
365
"""Get the target for a given file_id.
358
367
It is assumed that the caller already knows that file_id is referencing
360
369
:param file_id: Handle for the symlink entry.
370
:param path: The path of the file.
371
If both file_id and path are supplied, an implementation may use
361
373
:return: The path the symlink points to.
363
375
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
377
def get_root_id(self):
444
378
"""Return the file_id for the root of this tree."""
445
379
raise NotImplementedError(self.get_root_id)
503
437
except errors.NoSuchRevisionInTree:
504
438
yield self.repository.revision_tree(revision_id)
507
def _file_revision(revision_tree, file_id):
508
"""Determine the revision associated with a file in a given tree."""
509
revision_tree.lock_read()
511
return revision_tree.inventory[file_id].revision
513
revision_tree.unlock()
515
440
def _get_file_revision(self, file_id, vf, tree_revision):
516
441
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
518
443
if getattr(self, '_repository', None) is None:
519
444
last_revision = tree_revision
520
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
445
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
446
self._iter_parent_trees()]
522
447
vf.add_lines((file_id, last_revision), parent_keys,
523
self.get_file(file_id).readlines())
448
self.get_file_lines(file_id))
524
449
repo = self.branch.repository
525
450
base_vf = repo.texts
527
last_revision = self._file_revision(self, file_id)
452
last_revision = self.get_file_revision(file_id)
528
453
base_vf = self._repository.texts
529
454
if base_vf not in vf.fallback_versionedfiles:
530
455
vf.fallback_versionedfiles.append(base_vf)
531
456
return last_revision
533
inventory = property(_get_inventory,
534
doc="Inventory of this Tree")
536
458
def _check_retrieved(self, ie, f):
537
459
if not __debug__:
539
fp = fingerprint_file(f)
461
fp = osutils.fingerprint_file(f)
542
464
if ie.text_size is not None:
543
465
if ie.text_size != fp['size']:
544
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
466
raise errors.BzrError(
467
"mismatched size for file %r in %r" %
468
(ie.file_id, self._store),
545
469
["inventory expects %d bytes" % ie.text_size,
546
470
"file is actually %d bytes" % fp['size'],
547
471
"store is probably damaged/corrupt"])
549
473
if ie.text_sha1 != fp['sha1']:
550
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
474
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
475
(ie.file_id, self._store),
551
476
["inventory expects %s" % ie.text_sha1,
552
477
"file is actually %s" % fp['sha1'],
553
478
"store is probably damaged/corrupt"])
556
480
def path2id(self, path):
557
481
"""Return the id for path in this tree."""
558
return self._inventory.path2id(path)
482
raise NotImplementedError(self.path2id)
560
484
def paths2ids(self, paths, trees=[], require_versioned=True):
561
485
"""Return all the ids that can be reached by walking from paths.
648
class InventoryTree(Tree):
649
"""A tree that relies on an inventory for its metadata.
651
Trees contain an `Inventory` object, and also know how to retrieve
652
file texts mentioned in the inventory, either from a working
653
directory or from a store.
655
It is possible for trees to contain files that are not described
656
in their inventory or vice versa; for this use `filenames()`.
658
Subclasses should set the _inventory attribute, which is considered
659
private to external API users.
662
def get_canonical_inventory_paths(self, paths):
663
"""Like get_canonical_inventory_path() but works on multiple items.
665
:param paths: A sequence of paths relative to the root of the tree.
666
:return: A list of paths, with each item the corresponding input path
667
adjusted to account for existing elements that match case
670
return list(self._yield_canonical_inventory_paths(paths))
672
def get_canonical_inventory_path(self, path):
673
"""Returns the first inventory item that case-insensitively matches path.
675
If a path matches exactly, it is returned. If no path matches exactly
676
but more than one path matches case-insensitively, it is implementation
677
defined which is returned.
679
If no path matches case-insensitively, the input path is returned, but
680
with as many path entries that do exist changed to their canonical
683
If you need to resolve many names from the same tree, you should
684
use get_canonical_inventory_paths() to avoid O(N) behaviour.
686
:param path: A paths relative to the root of the tree.
687
:return: The input path adjusted to account for existing elements
688
that match case insensitively.
690
return self._yield_canonical_inventory_paths([path]).next()
692
def _yield_canonical_inventory_paths(self, paths):
694
# First, if the path as specified exists exactly, just use it.
695
if self.path2id(path) is not None:
699
cur_id = self.get_root_id()
701
bit_iter = iter(path.split("/"))
705
for child in self.iter_children(cur_id):
707
# XXX: it seem like if the child is known to be in the
708
# tree, we shouldn't need to go from its id back to
709
# its path -- mbp 2010-02-11
711
# XXX: it seems like we could be more efficient
712
# by just directly looking up the original name and
713
# only then searching all children; also by not
714
# chopping paths so much. -- mbp 2010-02-11
715
child_base = os.path.basename(self.id2path(child))
716
if (child_base == elt):
717
# if we found an exact match, we can stop now; if
718
# we found an approximate match we need to keep
719
# searching because there might be an exact match
722
new_path = osutils.pathjoin(cur_path, child_base)
724
elif child_base.lower() == lelt:
726
new_path = osutils.pathjoin(cur_path, child_base)
727
except errors.NoSuchId:
728
# before a change is committed we can see this error...
733
# got to the end of this directory and no entries matched.
734
# Return what matched so far, plus the rest as specified.
735
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
740
def _get_inventory(self):
741
return self._inventory
743
inventory = property(_get_inventory,
744
doc="Inventory of this Tree")
747
def path2id(self, path):
748
"""Return the id for path in this tree."""
749
return self._inventory.path2id(path)
751
def id2path(self, file_id):
752
"""Return the path for a file id.
756
return self.inventory.id2path(file_id)
758
def has_id(self, file_id):
759
return self.inventory.has_id(file_id)
761
def has_or_had_id(self, file_id):
762
return self.inventory.has_id(file_id)
764
def all_file_ids(self):
765
return set(self.inventory)
767
@deprecated_method(deprecated_in((2, 4, 0)))
769
return iter(self.inventory)
771
def filter_unversioned_files(self, paths):
772
"""Filter out paths that are versioned.
774
:return: set of paths.
776
# NB: we specifically *don't* call self.has_filename, because for
777
# WorkingTrees that can indicate files that exist on disk but that
779
pred = self.inventory.has_filename
780
return set((p for p in paths if not pred(p)))
783
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
784
"""Walk the tree in 'by_dir' order.
786
This will yield each entry in the tree as a (path, entry) tuple.
787
The order that they are yielded is:
789
See Tree.iter_entries_by_dir for details.
791
:param yield_parents: If True, yield the parents from the root leading
792
down to specific_file_ids that have been requested. This has no
793
impact if specific_file_ids is None.
795
return self.inventory.iter_entries_by_dir(
796
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
798
def get_file_by_path(self, path):
799
return self.get_file(self._inventory.path2id(path), path)
724
802
######################################################################
added
removed
bzrlib/tree.py
