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