147
return iter(self.inventory)
149
145
def all_file_ids(self):
150
146
"""Iterate through all file ids, including ids for missing files."""
151
return set(self.inventory)
147
raise NotImplementedError(self.all_file_ids)
153
149
def id2path(self, file_id):
154
150
"""Return the path for a file id.
156
152
: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)
154
raise NotImplementedError(self.id2path)
173
156
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
174
157
"""Walk the tree in 'by_dir' order.
194
177
The yield order (ignoring root) would be::
195
179
a, f, a/b, a/d, a/b/c, a/d/e, f/g
197
181
:param yield_parents: If True, yield the parents from the root leading
198
182
down to specific_file_ids that have been requested. This has no
199
183
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)
185
raise NotImplementedError(self.iter_entries_by_dir)
187
def list_files(self, include_root=False, from_dir=None, recursive=True):
188
"""List all files in this tree.
190
:param include_root: Whether to include the entry for the tree root
191
:param from_dir: Directory under which to list files
192
:param recursive: Whether to list files recursively
193
:return: iterator over tuples of (path, versioned, kind, file_id,
196
raise NotImplementedError(self.list_files)
204
198
def iter_references(self):
205
199
if self.supports_tree_reference():
352
363
cur_file = (self.get_file_text(file_id),)
353
364
yield identifier, cur_file
355
def get_symlink_target(self, file_id):
366
def get_symlink_target(self, file_id, path=None):
356
367
"""Get the target for a given file_id.
358
369
It is assumed that the caller already knows that file_id is referencing
360
371
:param file_id: Handle for the symlink entry.
372
:param path: The path of the file.
373
If both file_id and path are supplied, an implementation may use
361
375
:return: The path the symlink points to.
363
377
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
379
def get_root_id(self):
444
380
"""Return the file_id for the root of this tree."""
445
381
raise NotImplementedError(self.get_root_id)
503
439
except errors.NoSuchRevisionInTree:
504
440
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
442
def _get_file_revision(self, file_id, vf, tree_revision):
516
443
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
518
445
if getattr(self, '_repository', None) is None:
519
446
last_revision = tree_revision
520
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
447
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
448
self._iter_parent_trees()]
522
449
vf.add_lines((file_id, last_revision), parent_keys,
523
self.get_file(file_id).readlines())
450
self.get_file_lines(file_id))
524
451
repo = self.branch.repository
525
452
base_vf = repo.texts
527
last_revision = self._file_revision(self, file_id)
454
last_revision = self.get_file_revision(file_id)
528
455
base_vf = self._repository.texts
529
456
if base_vf not in vf.fallback_versionedfiles:
530
457
vf.fallback_versionedfiles.append(base_vf)
531
458
return last_revision
533
inventory = property(_get_inventory,
534
doc="Inventory of this Tree")
536
460
def _check_retrieved(self, ie, f):
537
461
if not __debug__:
539
fp = fingerprint_file(f)
463
fp = osutils.fingerprint_file(f)
542
466
if ie.text_size is not None:
543
467
if ie.text_size != fp['size']:
544
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
468
raise errors.BzrError(
469
"mismatched size for file %r in %r" %
470
(ie.file_id, self._store),
545
471
["inventory expects %d bytes" % ie.text_size,
546
472
"file is actually %d bytes" % fp['size'],
547
473
"store is probably damaged/corrupt"])
549
475
if ie.text_sha1 != fp['sha1']:
550
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
476
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
477
(ie.file_id, self._store),
551
478
["inventory expects %s" % ie.text_sha1,
552
479
"file is actually %s" % fp['sha1'],
553
480
"store is probably damaged/corrupt"])
556
482
def path2id(self, path):
557
483
"""Return the id for path in this tree."""
558
return self._inventory.path2id(path)
484
raise NotImplementedError(self.path2id)
560
486
def paths2ids(self, paths, trees=[], require_versioned=True):
561
487
"""Return all the ids that can be reached by walking from paths.
650
class InventoryTree(Tree):
651
"""A tree that relies on an inventory for its metadata.
653
Trees contain an `Inventory` object, and also know how to retrieve
654
file texts mentioned in the inventory, either from a working
655
directory or from a store.
657
It is possible for trees to contain files that are not described
658
in their inventory or vice versa; for this use `filenames()`.
660
Subclasses should set the _inventory attribute, which is considered
661
private to external API users.
664
def get_canonical_inventory_paths(self, paths):
665
"""Like get_canonical_inventory_path() but works on multiple items.
667
:param paths: A sequence of paths relative to the root of the tree.
668
:return: A list of paths, with each item the corresponding input path
669
adjusted to account for existing elements that match case
672
return list(self._yield_canonical_inventory_paths(paths))
674
def get_canonical_inventory_path(self, path):
675
"""Returns the first inventory item that case-insensitively matches path.
677
If a path matches exactly, it is returned. If no path matches exactly
678
but more than one path matches case-insensitively, it is implementation
679
defined which is returned.
681
If no path matches case-insensitively, the input path is returned, but
682
with as many path entries that do exist changed to their canonical
685
If you need to resolve many names from the same tree, you should
686
use get_canonical_inventory_paths() to avoid O(N) behaviour.
688
:param path: A paths relative to the root of the tree.
689
:return: The input path adjusted to account for existing elements
690
that match case insensitively.
692
return self._yield_canonical_inventory_paths([path]).next()
694
def _yield_canonical_inventory_paths(self, paths):
696
# First, if the path as specified exists exactly, just use it.
697
if self.path2id(path) is not None:
701
cur_id = self.get_root_id()
703
bit_iter = iter(path.split("/"))
707
for child in self.iter_children(cur_id):
709
# XXX: it seem like if the child is known to be in the
710
# tree, we shouldn't need to go from its id back to
711
# its path -- mbp 2010-02-11
713
# XXX: it seems like we could be more efficient
714
# by just directly looking up the original name and
715
# only then searching all children; also by not
716
# chopping paths so much. -- mbp 2010-02-11
717
child_base = os.path.basename(self.id2path(child))
718
if (child_base == elt):
719
# if we found an exact match, we can stop now; if
720
# we found an approximate match we need to keep
721
# searching because there might be an exact match
724
new_path = osutils.pathjoin(cur_path, child_base)
726
elif child_base.lower() == lelt:
728
new_path = osutils.pathjoin(cur_path, child_base)
729
except errors.NoSuchId:
730
# before a change is committed we can see this error...
735
# got to the end of this directory and no entries matched.
736
# Return what matched so far, plus the rest as specified.
737
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
742
def _get_inventory(self):
743
return self._inventory
745
inventory = property(_get_inventory,
746
doc="Inventory of this Tree")
749
def path2id(self, path):
750
"""Return the id for path in this tree."""
751
return self._inventory.path2id(path)
753
def id2path(self, file_id):
754
"""Return the path for a file id.
758
return self.inventory.id2path(file_id)
760
def has_id(self, file_id):
761
return self.inventory.has_id(file_id)
763
def has_or_had_id(self, file_id):
764
return self.inventory.has_id(file_id)
766
def all_file_ids(self):
767
return set(self.inventory)
769
@deprecated_method(deprecated_in((2, 4, 0)))
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)
724
804
######################################################################
added
removed
bzrlib/tree.py
