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
362
cur_file = (self.get_file_text(file_id),)
353
363
yield identifier, cur_file
355
def get_symlink_target(self, file_id):
365
def get_symlink_target(self, file_id, path=None):
356
366
"""Get the target for a given file_id.
358
368
It is assumed that the caller already knows that file_id is referencing
360
370
:param file_id: Handle for the symlink entry.
371
:param path: The path of the file.
372
If both file_id and path are supplied, an implementation may use
361
374
:return: The path the symlink points to.
363
376
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
378
def get_root_id(self):
444
379
"""Return the file_id for the root of this tree."""
445
380
raise NotImplementedError(self.get_root_id)
503
438
except errors.NoSuchRevisionInTree:
504
439
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
441
def _get_file_revision(self, file_id, vf, tree_revision):
516
442
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
518
444
if getattr(self, '_repository', None) is None:
519
445
last_revision = tree_revision
520
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
446
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
447
self._iter_parent_trees()]
522
448
vf.add_lines((file_id, last_revision), parent_keys,
523
self.get_file(file_id).readlines())
449
self.get_file_lines(file_id))
524
450
repo = self.branch.repository
525
451
base_vf = repo.texts
527
last_revision = self._file_revision(self, file_id)
453
last_revision = self.get_file_revision(file_id)
528
454
base_vf = self._repository.texts
529
455
if base_vf not in vf.fallback_versionedfiles:
530
456
vf.fallback_versionedfiles.append(base_vf)
531
457
return last_revision
533
inventory = property(_get_inventory,
534
doc="Inventory of this Tree")
536
459
def _check_retrieved(self, ie, f):
537
460
if not __debug__:
539
fp = fingerprint_file(f)
462
fp = osutils.fingerprint_file(f)
542
465
if ie.text_size is not None:
543
466
if ie.text_size != fp['size']:
544
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
467
raise errors.BzrError(
468
"mismatched size for file %r in %r" %
469
(ie.file_id, self._store),
545
470
["inventory expects %d bytes" % ie.text_size,
546
471
"file is actually %d bytes" % fp['size'],
547
472
"store is probably damaged/corrupt"])
549
474
if ie.text_sha1 != fp['sha1']:
550
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
475
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
476
(ie.file_id, self._store),
551
477
["inventory expects %s" % ie.text_sha1,
552
478
"file is actually %s" % fp['sha1'],
553
479
"store is probably damaged/corrupt"])
556
481
def path2id(self, path):
557
482
"""Return the id for path in this tree."""
558
return self._inventory.path2id(path)
483
raise NotImplementedError(self.path2id)
560
485
def paths2ids(self, paths, trees=[], require_versioned=True):
561
486
"""Return all the ids that can be reached by walking from paths.
649
class InventoryTree(Tree):
650
"""A tree that relies on an inventory for its metadata.
652
Trees contain an `Inventory` object, and also know how to retrieve
653
file texts mentioned in the inventory, either from a working
654
directory or from a store.
656
It is possible for trees to contain files that are not described
657
in their inventory or vice versa; for this use `filenames()`.
659
Subclasses should set the _inventory attribute, which is considered
660
private to external API users.
663
def get_canonical_inventory_paths(self, paths):
664
"""Like get_canonical_inventory_path() but works on multiple items.
666
:param paths: A sequence of paths relative to the root of the tree.
667
:return: A list of paths, with each item the corresponding input path
668
adjusted to account for existing elements that match case
671
return list(self._yield_canonical_inventory_paths(paths))
673
def get_canonical_inventory_path(self, path):
674
"""Returns the first inventory item that case-insensitively matches path.
676
If a path matches exactly, it is returned. If no path matches exactly
677
but more than one path matches case-insensitively, it is implementation
678
defined which is returned.
680
If no path matches case-insensitively, the input path is returned, but
681
with as many path entries that do exist changed to their canonical
684
If you need to resolve many names from the same tree, you should
685
use get_canonical_inventory_paths() to avoid O(N) behaviour.
687
:param path: A paths relative to the root of the tree.
688
:return: The input path adjusted to account for existing elements
689
that match case insensitively.
691
return self._yield_canonical_inventory_paths([path]).next()
693
def _yield_canonical_inventory_paths(self, paths):
695
# First, if the path as specified exists exactly, just use it.
696
if self.path2id(path) is not None:
700
cur_id = self.get_root_id()
702
bit_iter = iter(path.split("/"))
706
for child in self.iter_children(cur_id):
708
# XXX: it seem like if the child is known to be in the
709
# tree, we shouldn't need to go from its id back to
710
# its path -- mbp 2010-02-11
712
# XXX: it seems like we could be more efficient
713
# by just directly looking up the original name and
714
# only then searching all children; also by not
715
# chopping paths so much. -- mbp 2010-02-11
716
child_base = os.path.basename(self.id2path(child))
717
if (child_base == elt):
718
# if we found an exact match, we can stop now; if
719
# we found an approximate match we need to keep
720
# searching because there might be an exact match
723
new_path = osutils.pathjoin(cur_path, child_base)
725
elif child_base.lower() == lelt:
727
new_path = osutils.pathjoin(cur_path, child_base)
728
except errors.NoSuchId:
729
# before a change is committed we can see this error...
734
# got to the end of this directory and no entries matched.
735
# Return what matched so far, plus the rest as specified.
736
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
741
def _get_inventory(self):
742
return self._inventory
744
inventory = property(_get_inventory,
745
doc="Inventory of this Tree")
748
def path2id(self, path):
749
"""Return the id for path in this tree."""
750
return self._inventory.path2id(path)
752
def id2path(self, file_id):
753
"""Return the path for a file id.
757
return self.inventory.id2path(file_id)
759
def has_id(self, file_id):
760
return self.inventory.has_id(file_id)
762
def has_or_had_id(self, file_id):
763
return self.inventory.has_id(file_id)
765
def all_file_ids(self):
766
return set(self.inventory)
768
@deprecated_method(deprecated_in((2, 4, 0)))
770
return iter(self.inventory)
772
def filter_unversioned_files(self, paths):
773
"""Filter out paths that are versioned.
775
:return: set of paths.
777
# NB: we specifically *don't* call self.has_filename, because for
778
# WorkingTrees that can indicate files that exist on disk but that
780
pred = self.inventory.has_filename
781
return set((p for p in paths if not pred(p)))
784
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
785
"""Walk the tree in 'by_dir' order.
787
This will yield each entry in the tree as a (path, entry) tuple.
788
The order that they are yielded is:
790
See Tree.iter_entries_by_dir for details.
792
:param yield_parents: If True, yield the parents from the root leading
793
down to specific_file_ids that have been requested. This has no
794
impact if specific_file_ids is None.
796
return self.inventory.iter_entries_by_dir(
797
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
799
def get_file_by_path(self, path):
800
return self.get_file(self._inventory.path2id(path), path)
724
803
######################################################################
added
removed
bzrlib/tree.py
