1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tree classes, representing directory at point in time.
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
27
conflicts as _mod_conflicts,
34
revision as _mod_revision,
40
from bzrlib.decorators import needs_read_lock
41
from bzrlib.inter import InterObject
45
"""Abstract file tree.
47
There are several subclasses:
49
* `WorkingTree` exists as files on disk editable by the user.
51
* `RevisionTree` is a tree as recorded at some point in the past.
53
Trees can be compared, etc, regardless of whether they are working
54
trees or versioned trees.
57
def changes_from(self, other, want_unchanged=False, specific_files=None,
58
extra_trees=None, require_versioned=False, include_root=False,
59
want_unversioned=False):
60
"""Return a TreeDelta of the changes from other to this tree.
62
:param other: A tree to compare with.
63
:param specific_files: An optional list of file paths to restrict the
64
comparison to. When mapping filenames to ids, all matches in all
65
trees (including optional extra_trees) are used, and all children of
66
matched directories are included.
67
:param want_unchanged: An optional boolean requesting the inclusion of
68
unchanged entries in the result.
69
:param extra_trees: An optional list of additional trees to use when
70
mapping the contents of specific_files (paths) to file_ids.
71
:param require_versioned: An optional boolean (defaults to False). When
72
supplied and True all the 'specific_files' must be versioned, or
73
a PathsNotVersionedError will be thrown.
74
:param want_unversioned: Scan for unversioned paths.
76
The comparison will be performed by an InterTree object looked up on
79
# Martin observes that Tree.changes_from returns a TreeDelta and this
80
# may confuse people, because the class name of the returned object is
81
# a synonym of the object referenced in the method name.
82
return InterTree.get(other, self).compare(
83
want_unchanged=want_unchanged,
84
specific_files=specific_files,
85
extra_trees=extra_trees,
86
require_versioned=require_versioned,
87
include_root=include_root,
88
want_unversioned=want_unversioned,
91
def iter_changes(self, from_tree, include_unchanged=False,
92
specific_files=None, pb=None, extra_trees=None,
93
require_versioned=True, want_unversioned=False):
94
"""See InterTree.iter_changes"""
95
intertree = InterTree.get(from_tree, self)
96
return intertree.iter_changes(include_unchanged, specific_files, pb,
97
extra_trees, require_versioned, want_unversioned=want_unversioned)
100
"""Get a list of the conflicts in the tree.
102
Each conflict is an instance of bzrlib.conflicts.Conflict.
104
return _mod_conflicts.ConflictList()
107
"""For trees that can have unversioned files, return all such paths."""
110
def get_parent_ids(self):
111
"""Get the parent ids for this tree.
113
:return: a list of parent ids. [] is returned to indicate
114
a tree with no parents.
115
:raises: BzrError if the parents are not known.
117
raise NotImplementedError(self.get_parent_ids)
119
def has_filename(self, filename):
120
"""True if the tree has given filename."""
121
raise NotImplementedError(self.has_filename)
123
def has_id(self, file_id):
124
raise NotImplementedError(self.has_id)
126
def __contains__(self, file_id):
127
return self.has_id(file_id)
129
def has_or_had_id(self, file_id):
130
raise NotImplementedError(self.has_or_had_id)
132
def is_ignored(self, filename):
133
"""Check whether the filename is ignored by this tree.
135
:param filename: The relative filename within the tree.
136
:return: True if the filename is ignored.
141
"""Yield all file ids in this tree."""
142
raise NotImplementedError(self.__iter__)
144
def all_file_ids(self):
145
"""Iterate through all file ids, including ids for missing files."""
146
return set(self.inventory)
148
def id2path(self, file_id):
149
"""Return the path for a file id.
153
raise NotImplementedError(self.id2path)
155
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
156
"""Walk the tree in 'by_dir' order.
158
This will yield each entry in the tree as a (path, entry) tuple.
159
The order that they are yielded is:
161
Directories are walked in a depth-first lexicographical order,
162
however, whenever a directory is reached, all of its direct child
163
nodes are yielded in lexicographical order before yielding the
166
For example, in the tree::
176
The yield order (ignoring root) would be::
177
a, f, a/b, a/d, a/b/c, a/d/e, f/g
179
:param yield_parents: If True, yield the parents from the root leading
180
down to specific_file_ids that have been requested. This has no
181
impact if specific_file_ids is None.
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)
196
def iter_references(self):
197
if self.supports_tree_reference():
198
for path, entry in self.iter_entries_by_dir():
199
if entry.kind == 'tree-reference':
200
yield path, entry.file_id
202
def kind(self, file_id):
203
raise NotImplementedError("Tree subclass %s must implement kind"
204
% self.__class__.__name__)
206
def stored_kind(self, file_id):
207
"""File kind stored for this file_id.
209
May not match kind on disk for working trees. Always available
210
for versioned files, even when the file itself is missing.
212
return self.kind(file_id)
214
def path_content_summary(self, path):
215
"""Get a summary of the information about path.
217
All the attributes returned are for the canonical form, not the
218
convenient form (if content filters are in use.)
220
:param path: A relative path within the tree.
221
:return: A tuple containing kind, size, exec, sha1-or-link.
222
Kind is always present (see tree.kind()).
223
size is present if kind is file and the size of the
224
canonical form can be cheaply determined, None otherwise.
225
exec is None unless kind is file and the platform supports the 'x'
227
sha1-or-link is the link target if kind is symlink, or the sha1 if
228
it can be obtained without reading the file.
230
raise NotImplementedError(self.path_content_summary)
232
def get_reference_revision(self, file_id, path=None):
233
raise NotImplementedError("Tree subclass %s must implement "
234
"get_reference_revision"
235
% self.__class__.__name__)
237
def _comparison_data(self, entry, path):
238
"""Return a tuple of kind, executable, stat_value for a file.
240
entry may be None if there is no inventory entry for the file, but
241
path must always be supplied.
243
kind is None if there is no file present (even if an inventory id is
244
present). executable is False for non-file entries.
246
raise NotImplementedError(self._comparison_data)
248
def _file_size(self, entry, stat_value):
249
raise NotImplementedError(self._file_size)
251
def get_file(self, file_id, path=None):
252
"""Return a file object for the file file_id in the tree.
254
If both file_id and path are defined, it is implementation defined as
255
to which one is used.
257
raise NotImplementedError(self.get_file)
259
def get_file_with_stat(self, file_id, path=None):
260
"""Get a file handle and stat object for file_id.
262
The default implementation returns (self.get_file, None) for backwards
265
:param file_id: The file id to read.
266
:param path: The path of the file, if it is known.
267
:return: A tuple (file_handle, stat_value_or_None). If the tree has
268
no stat facility, or need for a stat cache feedback during commit,
269
it may return None for the second element of the tuple.
271
return (self.get_file(file_id, path), None)
273
def get_file_text(self, file_id, path=None):
274
"""Return the byte content of a file.
276
:param file_id: The file_id of the file.
277
:param path: The path of the file.
278
If both file_id and path are supplied, an implementation may use
281
my_file = self.get_file(file_id, path)
283
return my_file.read()
287
def get_file_lines(self, file_id, path=None):
288
"""Return the content of a file, as lines.
290
:param file_id: The file_id of the file.
291
:param path: The path of the file.
292
If both file_id and path are supplied, an implementation may use
295
return osutils.split_lines(self.get_file_text(file_id, path))
297
def get_file_sha1(self, file_id, path=None):
298
"""Return the SHA1 file for a file.
300
:param file_id: The handle for this file.
301
:param path: The path that this file can be found at.
302
These must point to the same object.
304
raise NotImplementedError(self.get_file_sha1)
306
def get_file_mtime(self, file_id, path=None):
307
"""Return the modification time for a file.
309
:param file_id: The handle for this file.
310
:param path: The path that this file can be found at.
311
These must point to the same object.
313
raise NotImplementedError(self.get_file_mtime)
315
def get_file_size(self, file_id):
316
"""Return the size of a file in bytes.
318
This applies only to regular files. If invoked on directories or
319
symlinks, it will return None.
320
:param file_id: The file-id of the file
322
raise NotImplementedError(self.get_file_size)
324
def get_file_by_path(self, path):
325
raise NotImplementedError(self.get_file_by_path)
327
def is_executable(self, file_id, path=None):
328
"""Check if a file is executable.
330
:param file_id: The handle for this file.
331
:param path: The path that this file can be found at.
332
These must point to the same object.
334
raise NotImplementedError(self.is_executable)
336
def iter_files_bytes(self, desired_files):
337
"""Iterate through file contents.
339
Files will not necessarily be returned in the order they occur in
340
desired_files. No specific order is guaranteed.
342
Yields pairs of identifier, bytes_iterator. identifier is an opaque
343
value supplied by the caller as part of desired_files. It should
344
uniquely identify the file version in the caller's context. (Examples:
345
an index number or a TreeTransform trans_id.)
347
bytes_iterator is an iterable of bytestrings for the file. The
348
kind of iterable and length of the bytestrings are unspecified, but for
349
this implementation, it is a tuple containing a single bytestring with
350
the complete text of the file.
352
:param desired_files: a list of (file_id, identifier) pairs
354
for file_id, identifier in desired_files:
355
# We wrap the string in a tuple so that we can return an iterable
356
# of bytestrings. (Technically, a bytestring is also an iterable
357
# of bytestrings, but iterating through each character is not
359
cur_file = (self.get_file_text(file_id),)
360
yield identifier, cur_file
362
def get_symlink_target(self, file_id):
363
"""Get the target for a given file_id.
365
It is assumed that the caller already knows that file_id is referencing
367
:param file_id: Handle for the symlink entry.
368
:return: The path the symlink points to.
370
raise NotImplementedError(self.get_symlink_target)
373
def get_root_id(self):
374
"""Return the file_id for the root of this tree."""
375
raise NotImplementedError(self.get_root_id)
377
def annotate_iter(self, file_id,
378
default_revision=_mod_revision.CURRENT_REVISION):
379
"""Return an iterator of revision_id, line tuples.
381
For working trees (and mutable trees in general), the special
382
revision_id 'current:' will be used for lines that are new in this
383
tree, e.g. uncommitted changes.
384
:param file_id: The file to produce an annotated version from
385
:param default_revision: For lines that don't match a basis, mark them
386
with this revision id. Not all implementations will make use of
389
raise NotImplementedError(self.annotate_iter)
391
def _get_plan_merge_data(self, file_id, other, base):
392
from bzrlib import versionedfile
393
vf = versionedfile._PlanMergeVersionedFile(file_id)
394
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
395
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
397
last_revision_base = None
399
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
400
return vf, last_revision_a, last_revision_b, last_revision_base
402
def plan_file_merge(self, file_id, other, base=None):
403
"""Generate a merge plan based on annotations.
405
If the file contains uncommitted changes in this tree, they will be
406
attributed to the 'current:' pseudo-revision. If the file contains
407
uncommitted changes in the other tree, they will be assigned to the
408
'other:' pseudo-revision.
410
data = self._get_plan_merge_data(file_id, other, base)
411
vf, last_revision_a, last_revision_b, last_revision_base = data
412
return vf.plan_merge(last_revision_a, last_revision_b,
415
def plan_file_lca_merge(self, file_id, other, base=None):
416
"""Generate a merge plan based lca-newness.
418
If the file contains uncommitted changes in this tree, they will be
419
attributed to the 'current:' pseudo-revision. If the file contains
420
uncommitted changes in the other tree, they will be assigned to the
421
'other:' pseudo-revision.
423
data = self._get_plan_merge_data(file_id, other, base)
424
vf, last_revision_a, last_revision_b, last_revision_base = data
425
return vf.plan_lca_merge(last_revision_a, last_revision_b,
428
def _iter_parent_trees(self):
429
"""Iterate through parent trees, defaulting to Tree.revision_tree."""
430
for revision_id in self.get_parent_ids():
432
yield self.revision_tree(revision_id)
433
except errors.NoSuchRevisionInTree:
434
yield self.repository.revision_tree(revision_id)
437
def _file_revision(revision_tree, file_id):
438
"""Determine the revision associated with a file in a given tree."""
439
# FIXME: Shouldn't this be a RevisionTree method?
440
revision_tree.lock_read()
442
return revision_tree.inventory[file_id].revision
444
revision_tree.unlock()
446
def _get_file_revision(self, file_id, vf, tree_revision):
447
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
449
if getattr(self, '_repository', None) is None:
450
last_revision = tree_revision
451
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
452
self._iter_parent_trees()]
453
vf.add_lines((file_id, last_revision), parent_keys,
454
self.get_file_lines(file_id))
455
repo = self.branch.repository
458
last_revision = self._file_revision(self, file_id)
459
base_vf = self._repository.texts
460
if base_vf not in vf.fallback_versionedfiles:
461
vf.fallback_versionedfiles.append(base_vf)
464
def _check_retrieved(self, ie, f):
467
fp = osutils.fingerprint_file(f)
470
if ie.text_size is not None:
471
if ie.text_size != fp['size']:
472
raise errors.BzrError(
473
"mismatched size for file %r in %r" %
474
(ie.file_id, self._store),
475
["inventory expects %d bytes" % ie.text_size,
476
"file is actually %d bytes" % fp['size'],
477
"store is probably damaged/corrupt"])
479
if ie.text_sha1 != fp['sha1']:
480
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
481
(ie.file_id, self._store),
482
["inventory expects %s" % ie.text_sha1,
483
"file is actually %s" % fp['sha1'],
484
"store is probably damaged/corrupt"])
486
def path2id(self, path):
487
"""Return the id for path in this tree."""
488
raise NotImplementedError(self.path2id)
490
def paths2ids(self, paths, trees=[], require_versioned=True):
491
"""Return all the ids that can be reached by walking from paths.
493
Each path is looked up in this tree and any extras provided in
494
trees, and this is repeated recursively: the children in an extra tree
495
of a directory that has been renamed under a provided path in this tree
496
are all returned, even if none exist under a provided path in this
497
tree, and vice versa.
499
:param paths: An iterable of paths to start converting to ids from.
500
Alternatively, if paths is None, no ids should be calculated and None
501
will be returned. This is offered to make calling the api unconditional
502
for code that *might* take a list of files.
503
:param trees: Additional trees to consider.
504
:param require_versioned: If False, do not raise NotVersionedError if
505
an element of paths is not versioned in this tree and all of trees.
507
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
509
def iter_children(self, file_id):
510
entry = self.iter_entries_by_dir([file_id]).next()[1]
511
for child in getattr(entry, 'children', {}).itervalues():
515
"""Lock this tree for multiple read only operations.
517
:return: A bzrlib.lock.LogicalLockResult.
521
def revision_tree(self, revision_id):
522
"""Obtain a revision tree for the revision revision_id.
524
The intention of this method is to allow access to possibly cached
525
tree data. Implementors of this method should raise NoSuchRevision if
526
the tree is not locally available, even if they could obtain the
527
tree via a repository or some other means. Callers are responsible
528
for finding the ultimate source for a revision tree.
530
:param revision_id: The revision_id of the requested tree.
532
:raises: NoSuchRevision if the tree cannot be obtained.
534
raise errors.NoSuchRevisionInTree(self, revision_id)
537
"""What files are present in this tree and unknown.
539
:return: an iterator over the unknown files.
546
def filter_unversioned_files(self, paths):
547
"""Filter out paths that are versioned.
549
:return: set of paths.
551
raise NotImplementedError(self.filter_unversioned_files)
553
def walkdirs(self, prefix=""):
554
"""Walk the contents of this tree from path down.
556
This yields all the data about the contents of a directory at a time.
557
After each directory has been yielded, if the caller has mutated the
558
list to exclude some directories, they are then not descended into.
560
The data yielded is of the form:
561
((directory-relpath, directory-path-from-root, directory-fileid),
562
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
563
versioned_kind), ...]),
564
- directory-relpath is the containing dirs relpath from prefix
565
- directory-path-from-root is the containing dirs path from /
566
- directory-fileid is the id of the directory if it is versioned.
567
- relpath is the relative path within the subtree being walked.
568
- basename is the basename
569
- kind is the kind of the file now. If unknonwn then the file is not
570
present within the tree - but it may be recorded as versioned. See
572
- lstat is the stat data *if* the file was statted.
573
- path_from_tree_root is the path from the root of the tree.
574
- file_id is the file_id if the entry is versioned.
575
- versioned_kind is the kind of the file as last recorded in the
576
versioning system. If 'unknown' the file is not versioned.
577
One of 'kind' and 'versioned_kind' must not be 'unknown'.
579
:param prefix: Start walking from prefix within the tree rather than
580
at the root. This allows one to walk a subtree but get paths that are
581
relative to a tree rooted higher up.
582
:return: an iterator over the directory data.
584
raise NotImplementedError(self.walkdirs)
586
def supports_content_filtering(self):
589
def _content_filter_stack(self, path=None, file_id=None):
590
"""The stack of content filters for a path if filtering is supported.
592
Readers will be applied in first-to-last order.
593
Writers will be applied in last-to-first order.
594
Either the path or the file-id needs to be provided.
596
:param path: path relative to the root of the tree
598
:param file_id: file_id or None if unknown
599
:return: the list of filters - [] if there are none
601
filter_pref_names = filters._get_registered_names()
602
if len(filter_pref_names) == 0:
605
path = self.id2path(file_id)
606
prefs = self.iter_search_rules([path], filter_pref_names).next()
607
stk = filters._get_filter_stack_for(prefs)
608
if 'filters' in debug.debug_flags:
609
trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
612
def _content_filter_stack_provider(self):
613
"""A function that returns a stack of ContentFilters.
615
The function takes a path (relative to the top of the tree) and a
616
file-id as parameters.
618
:return: None if content filtering is not supported by this tree.
620
if self.supports_content_filtering():
621
return lambda path, file_id: \
622
self._content_filter_stack(path, file_id)
626
def iter_search_rules(self, path_names, pref_names=None,
627
_default_searcher=None):
628
"""Find the preferences for filenames in a tree.
630
:param path_names: an iterable of paths to find attributes for.
631
Paths are given relative to the root of the tree.
632
:param pref_names: the list of preferences to lookup - None for all
633
:param _default_searcher: private parameter to assist testing - don't use
634
:return: an iterator of tuple sequences, one per path-name.
635
See _RulesSearcher.get_items for details on the tuple sequence.
637
if _default_searcher is None:
638
_default_searcher = rules._per_user_searcher
639
searcher = self._get_rules_searcher(_default_searcher)
640
if searcher is not None:
641
if pref_names is not None:
642
for path in path_names:
643
yield searcher.get_selected_items(path, pref_names)
645
for path in path_names:
646
yield searcher.get_items(path)
648
def _get_rules_searcher(self, default_searcher):
649
"""Get the RulesSearcher for this tree given the default one."""
650
searcher = default_searcher
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)
804
######################################################################
807
# TODO: Merge these two functions into a single one that can operate
808
# on either a whole tree or a set of files.
810
# TODO: Return the diff in order by filename, not by category or in
811
# random order. Can probably be done by lock-stepping through the
812
# filenames from both trees.
815
def file_status(filename, old_tree, new_tree):
816
"""Return single-letter status, old and new names for a file.
818
The complexity here is in deciding how to represent renames;
819
many complex cases are possible.
821
old_inv = old_tree.inventory
822
new_inv = new_tree.inventory
823
new_id = new_inv.path2id(filename)
824
old_id = old_inv.path2id(filename)
826
if not new_id and not old_id:
827
# easy: doesn't exist in either; not versioned at all
828
if new_tree.is_ignored(filename):
829
return 'I', None, None
831
return '?', None, None
833
# There is now a file of this name, great.
836
# There is no longer a file of this name, but we can describe
837
# what happened to the file that used to have
838
# this name. There are two possibilities: either it was
839
# deleted entirely, or renamed.
840
if new_inv.has_id(old_id):
841
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
843
return 'D', old_inv.id2path(old_id), None
845
# if the file_id is new in this revision, it is added
846
if new_id and not old_inv.has_id(new_id):
849
# if there used to be a file of this name, but that ID has now
850
# disappeared, it is deleted
851
if old_id and not new_inv.has_id(old_id):
857
def find_ids_across_trees(filenames, trees, require_versioned=True):
858
"""Find the ids corresponding to specified filenames.
860
All matches in all trees will be used, and all children of matched
861
directories will be used.
863
:param filenames: The filenames to find file_ids for (if None, returns
865
:param trees: The trees to find file_ids within
866
:param require_versioned: if true, all specified filenames must occur in
868
:return: a set of file ids for the specified filenames and their children.
872
specified_path_ids = _find_ids_across_trees(filenames, trees,
874
return _find_children_across_trees(specified_path_ids, trees)
877
def _find_ids_across_trees(filenames, trees, require_versioned):
878
"""Find the ids corresponding to specified filenames.
880
All matches in all trees will be used, but subdirectories are not scanned.
882
:param filenames: The filenames to find file_ids for
883
:param trees: The trees to find file_ids within
884
:param require_versioned: if true, all specified filenames must occur in
886
:return: a set of file ids for the specified filenames
889
interesting_ids = set()
890
for tree_path in filenames:
893
file_id = tree.path2id(tree_path)
894
if file_id is not None:
895
interesting_ids.add(file_id)
898
not_versioned.append(tree_path)
899
if len(not_versioned) > 0 and require_versioned:
900
raise errors.PathsNotVersionedError(not_versioned)
901
return interesting_ids
904
def _find_children_across_trees(specified_ids, trees):
905
"""Return a set including specified ids and their children.
907
All matches in all trees will be used.
909
:param trees: The trees to find file_ids within
910
:return: a set containing all specified ids and their children
912
interesting_ids = set(specified_ids)
913
pending = interesting_ids
914
# now handle children of interesting ids
915
# we loop so that we handle all children of each id in both trees
916
while len(pending) > 0:
918
for file_id in pending:
920
if not tree.has_or_had_id(file_id):
922
for child_id in tree.iter_children(file_id):
923
if child_id not in interesting_ids:
924
new_pending.add(child_id)
925
interesting_ids.update(new_pending)
926
pending = new_pending
927
return interesting_ids
930
class InterTree(InterObject):
931
"""This class represents operations taking place between two Trees.
933
Its instances have methods like 'compare' and contain references to the
934
source and target trees these operations are to be carried out on.
936
Clients of bzrlib should not need to use InterTree directly, rather they
937
should use the convenience methods on Tree such as 'Tree.compare()' which
938
will pass through to InterTree as appropriate.
941
# Formats that will be used to test this InterTree. If both are
942
# None, this InterTree will not be tested (e.g. because a complex
944
_matching_from_tree_format = None
945
_matching_to_tree_format = None
949
def _changes_from_entries(self, source_entry, target_entry,
950
source_path=None, target_path=None):
951
"""Generate a iter_changes tuple between source_entry and target_entry.
953
:param source_entry: An inventory entry from self.source, or None.
954
:param target_entry: An inventory entry from self.target, or None.
955
:param source_path: The path of source_entry, if known. If not known
956
it will be looked up.
957
:param target_path: The path of target_entry, if known. If not known
958
it will be looked up.
959
:return: A tuple, item 0 of which is an iter_changes result tuple, and
960
item 1 is True if there are any changes in the result tuple.
962
if source_entry is None:
963
if target_entry is None:
965
file_id = target_entry.file_id
967
file_id = source_entry.file_id
968
if source_entry is not None:
969
source_versioned = True
970
source_name = source_entry.name
971
source_parent = source_entry.parent_id
972
if source_path is None:
973
source_path = self.source.id2path(file_id)
974
source_kind, source_executable, source_stat = \
975
self.source._comparison_data(source_entry, source_path)
977
source_versioned = False
981
source_executable = None
982
if target_entry is not None:
983
target_versioned = True
984
target_name = target_entry.name
985
target_parent = target_entry.parent_id
986
if target_path is None:
987
target_path = self.target.id2path(file_id)
988
target_kind, target_executable, target_stat = \
989
self.target._comparison_data(target_entry, target_path)
991
target_versioned = False
995
target_executable = None
996
versioned = (source_versioned, target_versioned)
997
kind = (source_kind, target_kind)
998
changed_content = False
999
if source_kind != target_kind:
1000
changed_content = True
1001
elif source_kind == 'file':
1002
if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
1003
self.target.get_file_sha1(file_id, target_path, target_stat)):
1004
changed_content = True
1005
elif source_kind == 'symlink':
1006
if (self.source.get_symlink_target(file_id) !=
1007
self.target.get_symlink_target(file_id)):
1008
changed_content = True
1009
# XXX: Yes, the indentation below is wrong. But fixing it broke
1010
# test_merge.TestMergerEntriesLCAOnDisk.
1011
# test_nested_tree_subtree_renamed_and_modified. We'll wait for
1012
# the fix from bzr.dev -- vila 2009026
1013
elif source_kind == 'tree-reference':
1014
if (self.source.get_reference_revision(file_id, source_path)
1015
!= self.target.get_reference_revision(file_id, target_path)):
1016
changed_content = True
1017
parent = (source_parent, target_parent)
1018
name = (source_name, target_name)
1019
executable = (source_executable, target_executable)
1020
if (changed_content is not False or versioned[0] != versioned[1]
1021
or parent[0] != parent[1] or name[0] != name[1] or
1022
executable[0] != executable[1]):
1026
return (file_id, (source_path, target_path), changed_content,
1027
versioned, parent, name, kind, executable), changes
1030
def compare(self, want_unchanged=False, specific_files=None,
1031
extra_trees=None, require_versioned=False, include_root=False,
1032
want_unversioned=False):
1033
"""Return the changes from source to target.
1035
:return: A TreeDelta.
1036
:param specific_files: An optional list of file paths to restrict the
1037
comparison to. When mapping filenames to ids, all matches in all
1038
trees (including optional extra_trees) are used, and all children of
1039
matched directories are included.
1040
:param want_unchanged: An optional boolean requesting the inclusion of
1041
unchanged entries in the result.
1042
:param extra_trees: An optional list of additional trees to use when
1043
mapping the contents of specific_files (paths) to file_ids.
1044
:param require_versioned: An optional boolean (defaults to False). When
1045
supplied and True all the 'specific_files' must be versioned, or
1046
a PathsNotVersionedError will be thrown.
1047
:param want_unversioned: Scan for unversioned paths.
1049
trees = (self.source,)
1050
if extra_trees is not None:
1051
trees = trees + tuple(extra_trees)
1052
# target is usually the newer tree:
1053
specific_file_ids = self.target.paths2ids(specific_files, trees,
1054
require_versioned=require_versioned)
1055
if specific_files and not specific_file_ids:
1056
# All files are unversioned, so just return an empty delta
1057
# _compare_trees would think we want a complete delta
1058
result = delta.TreeDelta()
1059
fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1060
result.unversioned = [(path, None,
1061
self.target._comparison_data(fake_entry, path)[0]) for path in
1064
return delta._compare_trees(self.source, self.target, want_unchanged,
1065
specific_files, include_root, extra_trees=extra_trees,
1066
require_versioned=require_versioned,
1067
want_unversioned=want_unversioned)
1069
def iter_changes(self, include_unchanged=False,
1070
specific_files=None, pb=None, extra_trees=[],
1071
require_versioned=True, want_unversioned=False):
1072
"""Generate an iterator of changes between trees.
1074
A tuple is returned:
1075
(file_id, (path_in_source, path_in_target),
1076
changed_content, versioned, parent, name, kind,
1079
Changed_content is True if the file's content has changed. This
1080
includes changes to its kind, and to a symlink's target.
1082
versioned, parent, name, kind, executable are tuples of (from, to).
1083
If a file is missing in a tree, its kind is None.
1085
Iteration is done in parent-to-child order, relative to the target
1088
There is no guarantee that all paths are in sorted order: the
1089
requirement to expand the search due to renames may result in children
1090
that should be found early being found late in the search, after
1091
lexically later results have been returned.
1092
:param require_versioned: Raise errors.PathsNotVersionedError if a
1093
path in the specific_files list is not versioned in one of
1094
source, target or extra_trees.
1095
:param specific_files: An optional list of file paths to restrict the
1096
comparison to. When mapping filenames to ids, all matches in all
1097
trees (including optional extra_trees) are used, and all children
1098
of matched directories are included. The parents in the target tree
1099
of the specific files up to and including the root of the tree are
1100
always evaluated for changes too.
1101
:param want_unversioned: Should unversioned files be returned in the
1102
output. An unversioned file is defined as one with (False, False)
1103
for the versioned pair.
1105
lookup_trees = [self.source]
1107
lookup_trees.extend(extra_trees)
1108
# The ids of items we need to examine to insure delta consistency.
1109
precise_file_ids = set()
1110
changed_file_ids = []
1111
if specific_files == []:
1112
specific_file_ids = []
1114
specific_file_ids = self.target.paths2ids(specific_files,
1115
lookup_trees, require_versioned=require_versioned)
1116
if specific_files is not None:
1117
# reparented or added entries must have their parents included
1118
# so that valid deltas can be created. The seen_parents set
1119
# tracks the parents that we need to have.
1120
# The seen_dirs set tracks directory entries we've yielded.
1121
# After outputting version object in to_entries we set difference
1122
# the two seen sets and start checking parents.
1123
seen_parents = set()
1125
if want_unversioned:
1126
all_unversioned = sorted([(p.split('/'), p) for p in
1127
self.target.extras()
1128
if specific_files is None or
1129
osutils.is_inside_any(specific_files, p)])
1130
all_unversioned = collections.deque(all_unversioned)
1132
all_unversioned = collections.deque()
1134
from_entries_by_dir = list(self.source.iter_entries_by_dir(
1135
specific_file_ids=specific_file_ids))
1136
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1137
to_entries_by_dir = list(self.target.iter_entries_by_dir(
1138
specific_file_ids=specific_file_ids))
1139
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1141
# the unversioned path lookup only occurs on real trees - where there
1142
# can be extras. So the fake_entry is solely used to look up
1143
# executable it values when execute is not supported.
1144
fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1145
for target_path, target_entry in to_entries_by_dir:
1146
while (all_unversioned and
1147
all_unversioned[0][0] < target_path.split('/')):
1148
unversioned_path = all_unversioned.popleft()
1149
target_kind, target_executable, target_stat = \
1150
self.target._comparison_data(fake_entry, unversioned_path[1])
1151
yield (None, (None, unversioned_path[1]), True, (False, False),
1153
(None, unversioned_path[0][-1]),
1154
(None, target_kind),
1155
(None, target_executable))
1156
source_path, source_entry = from_data.get(target_entry.file_id,
1158
result, changes = self._changes_from_entries(source_entry,
1159
target_entry, source_path=source_path, target_path=target_path)
1160
to_paths[result[0]] = result[1][1]
1165
pb.update('comparing files', entry_count, num_entries)
1166
if changes or include_unchanged:
1167
if specific_file_ids is not None:
1168
new_parent_id = result[4][1]
1169
precise_file_ids.add(new_parent_id)
1170
changed_file_ids.append(result[0])
1172
# Ensure correct behaviour for reparented/added specific files.
1173
if specific_files is not None:
1174
# Record output dirs
1175
if result[6][1] == 'directory':
1176
seen_dirs.add(result[0])
1177
# Record parents of reparented/added entries.
1178
versioned = result[3]
1180
if not versioned[0] or parents[0] != parents[1]:
1181
seen_parents.add(parents[1])
1182
while all_unversioned:
1183
# yield any trailing unversioned paths
1184
unversioned_path = all_unversioned.popleft()
1185
to_kind, to_executable, to_stat = \
1186
self.target._comparison_data(fake_entry, unversioned_path[1])
1187
yield (None, (None, unversioned_path[1]), True, (False, False),
1189
(None, unversioned_path[0][-1]),
1191
(None, to_executable))
1192
# Yield all remaining source paths
1193
for path, from_entry in from_entries_by_dir:
1194
file_id = from_entry.file_id
1195
if file_id in to_paths:
1198
if not self.target.has_id(file_id):
1199
# common case - paths we have not emitted are not present in
1203
to_path = self.target.id2path(file_id)
1206
pb.update('comparing files', entry_count, num_entries)
1207
versioned = (True, False)
1208
parent = (from_entry.parent_id, None)
1209
name = (from_entry.name, None)
1210
from_kind, from_executable, stat_value = \
1211
self.source._comparison_data(from_entry, path)
1212
kind = (from_kind, None)
1213
executable = (from_executable, None)
1214
changed_content = from_kind is not None
1215
# the parent's path is necessarily known at this point.
1216
changed_file_ids.append(file_id)
1217
yield(file_id, (path, to_path), changed_content, versioned, parent,
1218
name, kind, executable)
1219
changed_file_ids = set(changed_file_ids)
1220
if specific_file_ids is not None:
1221
for result in self._handle_precise_ids(precise_file_ids,
1225
def _get_entry(self, tree, file_id):
1226
"""Get an inventory entry from a tree, with missing entries as None.
1228
If the tree raises NotImplementedError on accessing .inventory, then
1229
this is worked around using iter_entries_by_dir on just the file id
1232
:param tree: The tree to lookup the entry in.
1233
:param file_id: The file_id to lookup.
1236
inventory = tree.inventory
1237
except NotImplementedError:
1238
# No inventory available.
1240
iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1241
return iterator.next()[1]
1242
except StopIteration:
1246
return inventory[file_id]
1247
except errors.NoSuchId:
1250
def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1251
discarded_changes=None):
1252
"""Fill out a partial iter_changes to be consistent.
1254
:param precise_file_ids: The file ids of parents that were seen during
1256
:param changed_file_ids: The file ids of already emitted items.
1257
:param discarded_changes: An optional dict of precalculated
1258
iter_changes items which the partial iter_changes had not output
1260
:return: A generator of iter_changes items to output.
1262
# process parents of things that had changed under the users
1263
# requested paths to prevent incorrect paths or parent ids which
1264
# aren't in the tree.
1265
while precise_file_ids:
1266
precise_file_ids.discard(None)
1267
# Don't emit file_ids twice
1268
precise_file_ids.difference_update(changed_file_ids)
1269
if not precise_file_ids:
1271
# If the there was something at a given output path in source, we
1272
# have to include the entry from source in the delta, or we would
1273
# be putting this entry into a used path.
1275
for parent_id in precise_file_ids:
1277
paths.append(self.target.id2path(parent_id))
1278
except errors.NoSuchId:
1279
# This id has been dragged in from the source by delta
1280
# expansion and isn't present in target at all: we don't
1281
# need to check for path collisions on it.
1284
old_id = self.source.path2id(path)
1285
precise_file_ids.add(old_id)
1286
precise_file_ids.discard(None)
1287
current_ids = precise_file_ids
1288
precise_file_ids = set()
1289
# We have to emit all of precise_file_ids that have been altered.
1290
# We may have to output the children of some of those ids if any
1291
# directories have stopped being directories.
1292
for file_id in current_ids:
1294
if discarded_changes:
1295
result = discarded_changes.get(file_id)
1300
old_entry = self._get_entry(self.source, file_id)
1301
new_entry = self._get_entry(self.target, file_id)
1302
result, changes = self._changes_from_entries(
1303
old_entry, new_entry)
1306
# Get this parents parent to examine.
1307
new_parent_id = result[4][1]
1308
precise_file_ids.add(new_parent_id)
1310
if (result[6][0] == 'directory' and
1311
result[6][1] != 'directory'):
1312
# This stopped being a directory, the old children have
1314
if old_entry is None:
1315
# Reusing a discarded change.
1316
old_entry = self._get_entry(self.source, file_id)
1317
for child in old_entry.children.values():
1318
precise_file_ids.add(child.file_id)
1319
changed_file_ids.add(result[0])
1323
class MultiWalker(object):
1324
"""Walk multiple trees simultaneously, getting combined results."""
1326
# Note: This could be written to not assume you can do out-of-order
1327
# lookups. Instead any nodes that don't match in all trees could be
1328
# marked as 'deferred', and then returned in the final cleanup loop.
1329
# For now, I think it is "nicer" to return things as close to the
1330
# "master_tree" order as we can.
1332
def __init__(self, master_tree, other_trees):
1333
"""Create a new MultiWalker.
1335
All trees being walked must implement "iter_entries_by_dir()", such
1336
that they yield (path, object) tuples, where that object will have a
1337
'.file_id' member, that can be used to check equality.
1339
:param master_tree: All trees will be 'slaved' to the master_tree such
1340
that nodes in master_tree will be used as 'first-pass' sync points.
1341
Any nodes that aren't in master_tree will be merged in a second
1343
:param other_trees: A list of other trees to walk simultaneously.
1345
self._master_tree = master_tree
1346
self._other_trees = other_trees
1348
# Keep track of any nodes that were properly processed just out of
1349
# order, that way we don't return them at the end, we don't have to
1350
# track *all* processed file_ids, just the out-of-order ones
1351
self._out_of_order_processed = set()
1354
def _step_one(iterator):
1355
"""Step an iter_entries_by_dir iterator.
1357
:return: (has_more, path, ie)
1358
If has_more is False, path and ie will be None.
1361
path, ie = iterator.next()
1362
except StopIteration:
1363
return False, None, None
1365
return True, path, ie
1368
def _cmp_path_by_dirblock(path1, path2):
1369
"""Compare two paths based on what directory they are in.
1371
This generates a sort order, such that all children of a directory are
1372
sorted together, and grandchildren are in the same order as the
1373
children appear. But all grandchildren come after all children.
1375
:param path1: first path
1376
:param path2: the second path
1377
:return: negative number if ``path1`` comes first,
1378
0 if paths are equal
1379
and a positive number if ``path2`` sorts first
1381
# Shortcut this special case
1384
# This is stolen from _dirstate_helpers_py.py, only switching it to
1385
# Unicode objects. Consider using encode_utf8() and then using the
1386
# optimized versions, or maybe writing optimized unicode versions.
1387
if not isinstance(path1, unicode):
1388
raise TypeError("'path1' must be a unicode string, not %s: %r"
1389
% (type(path1), path1))
1390
if not isinstance(path2, unicode):
1391
raise TypeError("'path2' must be a unicode string, not %s: %r"
1392
% (type(path2), path2))
1393
return cmp(MultiWalker._path_to_key(path1),
1394
MultiWalker._path_to_key(path2))
1397
def _path_to_key(path):
1398
dirname, basename = osutils.split(path)
1399
return (dirname.split(u'/'), basename)
1401
def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
1402
"""Lookup an inventory entry by file_id.
1404
This is called when an entry is missing in the normal order.
1405
Generally this is because a file was either renamed, or it was
1406
deleted/added. If the entry was found in the inventory and not in
1407
extra_entries, it will be added to self._out_of_order_processed
1409
:param extra_entries: A dictionary of {file_id: (path, ie)}. This
1410
should be filled with entries that were found before they were
1411
used. If file_id is present, it will be removed from the
1413
:param other_tree: The Tree to search, in case we didn't find the entry
1415
:param file_id: The file_id to look for
1416
:return: (path, ie) if found or (None, None) if not present.
1418
if file_id in extra_entries:
1419
return extra_entries.pop(file_id)
1420
# TODO: Is id2path better as the first call, or is
1421
# inventory[file_id] better as a first check?
1423
cur_path = other_tree.id2path(file_id)
1424
except errors.NoSuchId:
1426
if cur_path is None:
1429
self._out_of_order_processed.add(file_id)
1430
cur_ie = other_tree.inventory[file_id]
1431
return (cur_path, cur_ie)
1434
"""Match up the values in the different trees."""
1435
for result in self._walk_master_tree():
1437
self._finish_others()
1438
for result in self._walk_others():
1441
def _walk_master_tree(self):
1442
"""First pass, walk all trees in lock-step.
1444
When we are done, all nodes in the master_tree will have been
1445
processed. _other_walkers, _other_entries, and _others_extra will be
1446
set on 'self' for future processing.
1448
# This iterator has the most "inlining" done, because it tends to touch
1449
# every file in the tree, while the others only hit nodes that don't
1451
master_iterator = self._master_tree.iter_entries_by_dir()
1453
other_walkers = [other.iter_entries_by_dir()
1454
for other in self._other_trees]
1455
other_entries = [self._step_one(walker) for walker in other_walkers]
1456
# Track extra nodes in the other trees
1457
others_extra = [{} for i in xrange(len(self._other_trees))]
1459
master_has_more = True
1460
step_one = self._step_one
1461
lookup_by_file_id = self._lookup_by_file_id
1462
out_of_order_processed = self._out_of_order_processed
1464
while master_has_more:
1465
(master_has_more, path, master_ie) = step_one(master_iterator)
1466
if not master_has_more:
1469
file_id = master_ie.file_id
1471
other_values_append = other_values.append
1472
next_other_entries = []
1473
next_other_entries_append = next_other_entries.append
1474
for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
1475
if not other_has_more:
1476
other_values_append(lookup_by_file_id(
1477
others_extra[idx], self._other_trees[idx], file_id))
1478
next_other_entries_append((False, None, None))
1479
elif file_id == other_ie.file_id:
1480
# This is the critical code path, as most of the entries
1481
# should match between most trees.
1482
other_values_append((other_path, other_ie))
1483
next_other_entries_append(step_one(other_walkers[idx]))
1485
# This walker did not match, step it until it either
1486
# matches, or we know we are past the current walker.
1487
other_walker = other_walkers[idx]
1488
other_extra = others_extra[idx]
1489
while (other_has_more and
1490
self._cmp_path_by_dirblock(other_path, path) < 0):
1491
other_file_id = other_ie.file_id
1492
if other_file_id not in out_of_order_processed:
1493
other_extra[other_file_id] = (other_path, other_ie)
1494
other_has_more, other_path, other_ie = \
1495
step_one(other_walker)
1496
if other_has_more and other_ie.file_id == file_id:
1497
# We ended up walking to this point, match and step
1499
other_values_append((other_path, other_ie))
1500
other_has_more, other_path, other_ie = \
1501
step_one(other_walker)
1503
# This record isn't in the normal order, see if it
1505
other_values_append(lookup_by_file_id(
1506
other_extra, self._other_trees[idx], file_id))
1507
next_other_entries_append((other_has_more, other_path,
1509
other_entries = next_other_entries
1511
# We've matched all the walkers, yield this datapoint
1512
yield path, file_id, master_ie, other_values
1513
self._other_walkers = other_walkers
1514
self._other_entries = other_entries
1515
self._others_extra = others_extra
1517
def _finish_others(self):
1518
"""Finish walking the other iterators, so we get all entries."""
1519
for idx, info in enumerate(self._other_entries):
1520
other_extra = self._others_extra[idx]
1521
(other_has_more, other_path, other_ie) = info
1522
while other_has_more:
1523
other_file_id = other_ie.file_id
1524
if other_file_id not in self._out_of_order_processed:
1525
other_extra[other_file_id] = (other_path, other_ie)
1526
other_has_more, other_path, other_ie = \
1527
self._step_one(self._other_walkers[idx])
1528
del self._other_entries
1530
def _walk_others(self):
1531
"""Finish up by walking all the 'deferred' nodes."""
1532
# TODO: One alternative would be to grab all possible unprocessed
1533
# file_ids, and then sort by path, and then yield them. That
1534
# might ensure better ordering, in case a caller strictly
1535
# requires parents before children.
1536
for idx, other_extra in enumerate(self._others_extra):
1537
others = sorted(other_extra.itervalues(),
1538
key=lambda x: self._path_to_key(x[0]))
1539
for other_path, other_ie in others:
1540
file_id = other_ie.file_id
1541
# We don't need to check out_of_order_processed here, because
1542
# the lookup_by_file_id will be removing anything processed
1543
# from the extras cache
1544
other_extra.pop(file_id)
1545
other_values = [(None, None) for i in xrange(idx)]
1546
other_values.append((other_path, other_ie))
1547
for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1548
alt_idx = alt_idx + idx + 1
1549
alt_extra = self._others_extra[alt_idx]
1550
alt_tree = self._other_trees[alt_idx]
1551
other_values.append(self._lookup_by_file_id(
1552
alt_extra, alt_tree, file_id))
1553
yield other_path, file_id, None, other_values