~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2011-07-04 21:10:37 UTC
  • mto: (6034.1.1 filter-tree)
  • mto: This revision was merged to the branch mainline in revision 6035.
  • Revision ID: mbp@canonical.com-20110704211037-ro3417imj3oqnqxp
Support exporting tarballs from ContentFilterTree

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
"""
19
19
 
20
20
import os
21
 
from collections import deque
22
 
 
23
 
import bzrlib
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import collections
 
25
 
24
26
from bzrlib import (
25
27
    conflicts as _mod_conflicts,
26
28
    debug,
27
29
    delta,
 
30
    errors,
28
31
    filters,
 
32
    inventory,
29
33
    osutils,
30
34
    revision as _mod_revision,
31
35
    rules,
 
36
    trace,
32
37
    )
 
38
""")
 
39
 
33
40
from bzrlib.decorators import needs_read_lock
34
 
from bzrlib.errors import BzrError, NoSuchId
35
 
from bzrlib import errors
36
 
from bzrlib.inventory import InventoryFile
37
41
from bzrlib.inter import InterObject
38
 
from bzrlib.osutils import fingerprint_file
39
 
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
40
 
from bzrlib.trace import note
 
42
from bzrlib.symbol_versioning import (
 
43
    deprecated_in,
 
44
    deprecated_method,
 
45
    )
41
46
 
42
47
 
43
48
class Tree(object):
49
54
 
50
55
    * `RevisionTree` is a tree as recorded at some point in the past.
51
56
 
52
 
    Trees contain an `Inventory` object, and also know how to retrieve
53
 
    file texts mentioned in the inventory, either from a working
54
 
    directory or from a store.
55
 
 
56
 
    It is possible for trees to contain files that are not described
57
 
    in their inventory or vice versa; for this use `filenames()`.
58
 
 
59
57
    Trees can be compared, etc, regardless of whether they are working
60
58
    trees or versioned trees.
61
59
    """
127
125
        raise NotImplementedError(self.has_filename)
128
126
 
129
127
    def has_id(self, file_id):
130
 
        return self.inventory.has_id(file_id)
 
128
        raise NotImplementedError(self.has_id)
131
129
 
 
130
    @deprecated_method(deprecated_in((2, 4, 0)))
132
131
    def __contains__(self, file_id):
133
132
        return self.has_id(file_id)
134
133
 
135
134
    def has_or_had_id(self, file_id):
136
 
        return self.inventory.has_id(file_id)
 
135
        raise NotImplementedError(self.has_or_had_id)
137
136
 
138
137
    def is_ignored(self, filename):
139
138
        """Check whether the filename is ignored by this tree.
143
142
        """
144
143
        return False
145
144
 
146
 
    def __iter__(self):
147
 
        return iter(self.inventory)
148
 
 
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)
152
148
 
153
149
    def id2path(self, file_id):
154
150
        """Return the path for a file id.
155
151
 
156
152
        :raises NoSuchId:
157
153
        """
158
 
        return self.inventory.id2path(file_id)
159
 
 
160
 
    def is_control_filename(self, filename):
161
 
        """True if filename is the name of a control file in this tree.
162
 
 
163
 
        :param filename: A filename within the tree. This is a relative path
164
 
        from the root of this tree.
165
 
 
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.
169
 
        """
170
 
        return self.bzrdir.is_control_filename(filename)
171
 
 
172
 
    @needs_read_lock
 
154
        raise NotImplementedError(self.id2path)
 
155
 
173
156
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
174
157
        """Walk the tree in 'by_dir' order.
175
158
 
192
175
             g
193
176
 
194
177
        The yield order (ignoring root) would be::
 
178
 
195
179
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
196
180
 
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.
200
184
        """
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)
 
186
 
 
187
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
188
        """List all files in this tree.
 
189
 
 
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,
 
194
            inventory entry)
 
195
        """
 
196
        raise NotImplementedError(self.list_files)
203
197
 
204
198
    def iter_references(self):
205
199
        if self.supports_tree_reference():
256
250
    def _file_size(self, entry, stat_value):
257
251
        raise NotImplementedError(self._file_size)
258
252
 
259
 
    def _get_inventory(self):
260
 
        return self._inventory
261
 
 
262
253
    def get_file(self, file_id, path=None):
263
254
        """Return a file object for the file file_id in the tree.
264
255
 
286
277
 
287
278
        :param file_id: The file_id of the file.
288
279
        :param path: The path of the file.
 
280
 
289
281
        If both file_id and path are supplied, an implementation may use
290
282
        either one.
 
283
 
 
284
        :returns: A single byte string for the whole file.
291
285
        """
292
286
        my_file = self.get_file(file_id, path)
293
287
        try:
300
294
 
301
295
        :param file_id: The file_id of the file.
302
296
        :param path: The path of the file.
 
297
 
303
298
        If both file_id and path are supplied, an implementation may use
304
299
        either one.
305
300
        """
306
301
        return osutils.split_lines(self.get_file_text(file_id, path))
307
302
 
 
303
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
304
        """Return the SHA1 file for a file.
 
305
 
 
306
        :param file_id: The handle for this file.
 
307
        :param path: The path that this file can be found at.
 
308
            These must point to the same object.
 
309
        :param stat_value: Optional stat value for the object
 
310
        """
 
311
        raise NotImplementedError(self.get_file_sha1)
 
312
 
308
313
    def get_file_mtime(self, file_id, path=None):
309
314
        """Return the modification time for a file.
310
315
 
324
329
        raise NotImplementedError(self.get_file_size)
325
330
 
326
331
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
332
        raise NotImplementedError(self.get_file_by_path)
 
333
 
 
334
    def is_executable(self, file_id, path=None):
 
335
        """Check if a file is executable.
 
336
 
 
337
        :param file_id: The handle for this file.
 
338
        :param path: The path that this file can be found at.
 
339
            These must point to the same object.
 
340
        """
 
341
        raise NotImplementedError(self.is_executable)
328
342
 
329
343
    def iter_files_bytes(self, desired_files):
330
344
        """Iterate through file contents.
352
366
            cur_file = (self.get_file_text(file_id),)
353
367
            yield identifier, cur_file
354
368
 
355
 
    def get_symlink_target(self, file_id):
 
369
    def get_symlink_target(self, file_id, path=None):
356
370
        """Get the target for a given file_id.
357
371
 
358
372
        It is assumed that the caller already knows that file_id is referencing
359
373
        a symlink.
360
374
        :param file_id: Handle for the symlink entry.
 
375
        :param path: The path of the file.
 
376
        If both file_id and path are supplied, an implementation may use
 
377
        either one.
361
378
        :return: The path the symlink points to.
362
379
        """
363
380
        raise NotImplementedError(self.get_symlink_target)
364
381
 
365
 
    def get_canonical_inventory_paths(self, paths):
366
 
        """Like get_canonical_inventory_path() but works on multiple items.
367
 
 
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
371
 
        insensitively.
372
 
        """
373
 
        return list(self._yield_canonical_inventory_paths(paths))
374
 
 
375
 
    def get_canonical_inventory_path(self, path):
376
 
        """Returns the first inventory item that case-insensitively matches path.
377
 
 
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.
381
 
 
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
384
 
        form.
385
 
 
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.
388
 
 
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.
392
 
        """
393
 
        return self._yield_canonical_inventory_paths([path]).next()
394
 
 
395
 
    def _yield_canonical_inventory_paths(self, paths):
396
 
        for path in paths:
397
 
            # First, if the path as specified exists exactly, just use it.
398
 
            if self.path2id(path) is not None:
399
 
                yield path
400
 
                continue
401
 
            # go walkin...
402
 
            cur_id = self.get_root_id()
403
 
            cur_path = ''
404
 
            bit_iter = iter(path.split("/"))
405
 
            for elt in bit_iter:
406
 
                lelt = elt.lower()
407
 
                new_path = None
408
 
                for child in self.iter_children(cur_id):
409
 
                    try:
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
413
 
                        #
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
423
 
                            # later.  
424
 
                            cur_id = child
425
 
                            new_path = osutils.pathjoin(cur_path, child_base)
426
 
                            break
427
 
                        elif child_base.lower() == lelt:
428
 
                            cur_id = child
429
 
                            new_path = osutils.pathjoin(cur_path, child_base)
430
 
                    except NoSuchId:
431
 
                        # before a change is committed we can see this error...
432
 
                        continue
433
 
                if new_path:
434
 
                    cur_path = new_path
435
 
                else:
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))
439
 
                    break
440
 
            yield cur_path
441
 
        # all done.
442
 
 
443
382
    def get_root_id(self):
444
383
        """Return the file_id for the root of this tree."""
445
384
        raise NotImplementedError(self.get_root_id)
503
442
            except errors.NoSuchRevisionInTree:
504
443
                yield self.repository.revision_tree(revision_id)
505
444
 
506
 
    @staticmethod
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()
510
 
        try:
511
 
            return revision_tree.inventory[file_id].revision
512
 
        finally:
513
 
            revision_tree.unlock()
514
 
 
515
445
    def _get_file_revision(self, file_id, vf, tree_revision):
516
446
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
517
447
 
518
448
        if getattr(self, '_repository', None) is None:
519
449
            last_revision = tree_revision
520
 
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
450
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
451
                self._iter_parent_trees()]
522
452
            vf.add_lines((file_id, last_revision), parent_keys,
523
 
                         self.get_file(file_id).readlines())
 
453
                         self.get_file_lines(file_id))
524
454
            repo = self.branch.repository
525
455
            base_vf = repo.texts
526
456
        else:
527
 
            last_revision = self._file_revision(self, file_id)
 
457
            last_revision = self.get_file_revision(file_id)
528
458
            base_vf = self._repository.texts
529
459
        if base_vf not in vf.fallback_versionedfiles:
530
460
            vf.fallback_versionedfiles.append(base_vf)
531
461
        return last_revision
532
462
 
533
 
    inventory = property(_get_inventory,
534
 
                         doc="Inventory of this Tree")
535
 
 
536
463
    def _check_retrieved(self, ie, f):
537
464
        if not __debug__:
538
465
            return
539
 
        fp = fingerprint_file(f)
 
466
        fp = osutils.fingerprint_file(f)
540
467
        f.seek(0)
541
468
 
542
469
        if ie.text_size is not None:
543
470
            if ie.text_size != fp['size']:
544
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
471
                raise errors.BzrError(
 
472
                        "mismatched size for file %r in %r" %
 
473
                        (ie.file_id, self._store),
545
474
                        ["inventory expects %d bytes" % ie.text_size,
546
475
                         "file is actually %d bytes" % fp['size'],
547
476
                         "store is probably damaged/corrupt"])
548
477
 
549
478
        if ie.text_sha1 != fp['sha1']:
550
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
479
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
 
480
                    (ie.file_id, self._store),
551
481
                    ["inventory expects %s" % ie.text_sha1,
552
482
                     "file is actually %s" % fp['sha1'],
553
483
                     "store is probably damaged/corrupt"])
554
484
 
555
 
    @needs_read_lock
556
485
    def path2id(self, path):
557
486
        """Return the id for path in this tree."""
558
 
        return self._inventory.path2id(path)
 
487
        raise NotImplementedError(self.path2id)
559
488
 
560
489
    def paths2ids(self, paths, trees=[], require_versioned=True):
561
490
        """Return all the ids that can be reached by walking from paths.
582
511
            yield child.file_id
583
512
 
584
513
    def lock_read(self):
 
514
        """Lock this tree for multiple read only operations.
 
515
        
 
516
        :return: A bzrlib.lock.LogicalLockResult.
 
517
        """
585
518
        pass
586
519
 
587
520
    def revision_tree(self, revision_id):
614
547
 
615
548
        :return: set of paths.
616
549
        """
617
 
        # NB: we specifically *don't* call self.has_filename, because for
618
 
        # WorkingTrees that can indicate files that exist on disk but that
619
 
        # are not versioned.
620
 
        pred = self.inventory.has_filename
621
 
        return set((p for p in paths if not pred(p)))
 
550
        raise NotImplementedError(self.filter_unversioned_files)
622
551
 
623
552
    def walkdirs(self, prefix=""):
624
553
        """Walk the contents of this tree from path down.
676
605
        prefs = self.iter_search_rules([path], filter_pref_names).next()
677
606
        stk = filters._get_filter_stack_for(prefs)
678
607
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
608
            trace.note("*** %s content-filter: %s => %r" % (path,prefs,stk))
680
609
        return stk
681
610
 
682
611
    def _content_filter_stack_provider(self):
721
650
        return searcher
722
651
 
723
652
 
724
 
######################################################################
725
 
# diff
726
 
 
727
 
# TODO: Merge these two functions into a single one that can operate
728
 
# on either a whole tree or a set of files.
729
 
 
730
 
# TODO: Return the diff in order by filename, not by category or in
731
 
# random order.  Can probably be done by lock-stepping through the
732
 
# filenames from both trees.
733
 
 
734
 
 
735
 
def file_status(filename, old_tree, new_tree):
736
 
    """Return single-letter status, old and new names for a file.
737
 
 
738
 
    The complexity here is in deciding how to represent renames;
739
 
    many complex cases are possible.
 
653
class InventoryTree(Tree):
 
654
    """A tree that relies on an inventory for its metadata.
 
655
 
 
656
    Trees contain an `Inventory` object, and also know how to retrieve
 
657
    file texts mentioned in the inventory, either from a working
 
658
    directory or from a store.
 
659
 
 
660
    It is possible for trees to contain files that are not described
 
661
    in their inventory or vice versa; for this use `filenames()`.
 
662
 
 
663
    Subclasses should set the _inventory attribute, which is considered
 
664
    private to external API users.
740
665
    """
741
 
    old_inv = old_tree.inventory
742
 
    new_inv = new_tree.inventory
743
 
    new_id = new_inv.path2id(filename)
744
 
    old_id = old_inv.path2id(filename)
745
 
 
746
 
    if not new_id and not old_id:
747
 
        # easy: doesn't exist in either; not versioned at all
748
 
        if new_tree.is_ignored(filename):
749
 
            return 'I', None, None
750
 
        else:
751
 
            return '?', None, None
752
 
    elif new_id:
753
 
        # There is now a file of this name, great.
754
 
        pass
755
 
    else:
756
 
        # There is no longer a file of this name, but we can describe
757
 
        # what happened to the file that used to have
758
 
        # this name.  There are two possibilities: either it was
759
 
        # deleted entirely, or renamed.
760
 
        if new_inv.has_id(old_id):
761
 
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
762
 
        else:
763
 
            return 'D', old_inv.id2path(old_id), None
764
 
 
765
 
    # if the file_id is new in this revision, it is added
766
 
    if new_id and not old_inv.has_id(new_id):
767
 
        return 'A'
768
 
 
769
 
    # if there used to be a file of this name, but that ID has now
770
 
    # disappeared, it is deleted
771
 
    if old_id and not new_inv.has_id(old_id):
772
 
        return 'D'
773
 
 
774
 
    return 'wtf?'
775
 
 
776
 
 
777
 
@deprecated_function(deprecated_in((1, 9, 0)))
778
 
def find_renames(old_inv, new_inv):
779
 
    for file_id in old_inv:
780
 
        if file_id not in new_inv:
781
 
            continue
782
 
        old_name = old_inv.id2path(file_id)
783
 
        new_name = new_inv.id2path(file_id)
784
 
        if old_name != new_name:
785
 
            yield (old_name, new_name)
 
666
 
 
667
    def get_canonical_inventory_paths(self, paths):
 
668
        """Like get_canonical_inventory_path() but works on multiple items.
 
669
 
 
670
        :param paths: A sequence of paths relative to the root of the tree.
 
671
        :return: A list of paths, with each item the corresponding input path
 
672
        adjusted to account for existing elements that match case
 
673
        insensitively.
 
674
        """
 
675
        return list(self._yield_canonical_inventory_paths(paths))
 
676
 
 
677
    def get_canonical_inventory_path(self, path):
 
678
        """Returns the first inventory item that case-insensitively matches path.
 
679
 
 
680
        If a path matches exactly, it is returned. If no path matches exactly
 
681
        but more than one path matches case-insensitively, it is implementation
 
682
        defined which is returned.
 
683
 
 
684
        If no path matches case-insensitively, the input path is returned, but
 
685
        with as many path entries that do exist changed to their canonical
 
686
        form.
 
687
 
 
688
        If you need to resolve many names from the same tree, you should
 
689
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
690
 
 
691
        :param path: A paths relative to the root of the tree.
 
692
        :return: The input path adjusted to account for existing elements
 
693
        that match case insensitively.
 
694
        """
 
695
        return self._yield_canonical_inventory_paths([path]).next()
 
696
 
 
697
    def _yield_canonical_inventory_paths(self, paths):
 
698
        for path in paths:
 
699
            # First, if the path as specified exists exactly, just use it.
 
700
            if self.path2id(path) is not None:
 
701
                yield path
 
702
                continue
 
703
            # go walkin...
 
704
            cur_id = self.get_root_id()
 
705
            cur_path = ''
 
706
            bit_iter = iter(path.split("/"))
 
707
            for elt in bit_iter:
 
708
                lelt = elt.lower()
 
709
                new_path = None
 
710
                for child in self.iter_children(cur_id):
 
711
                    try:
 
712
                        # XXX: it seem like if the child is known to be in the
 
713
                        # tree, we shouldn't need to go from its id back to
 
714
                        # its path -- mbp 2010-02-11
 
715
                        #
 
716
                        # XXX: it seems like we could be more efficient
 
717
                        # by just directly looking up the original name and
 
718
                        # only then searching all children; also by not
 
719
                        # chopping paths so much. -- mbp 2010-02-11
 
720
                        child_base = os.path.basename(self.id2path(child))
 
721
                        if (child_base == elt):
 
722
                            # if we found an exact match, we can stop now; if
 
723
                            # we found an approximate match we need to keep
 
724
                            # searching because there might be an exact match
 
725
                            # later.  
 
726
                            cur_id = child
 
727
                            new_path = osutils.pathjoin(cur_path, child_base)
 
728
                            break
 
729
                        elif child_base.lower() == lelt:
 
730
                            cur_id = child
 
731
                            new_path = osutils.pathjoin(cur_path, child_base)
 
732
                    except errors.NoSuchId:
 
733
                        # before a change is committed we can see this error...
 
734
                        continue
 
735
                if new_path:
 
736
                    cur_path = new_path
 
737
                else:
 
738
                    # got to the end of this directory and no entries matched.
 
739
                    # Return what matched so far, plus the rest as specified.
 
740
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
741
                    break
 
742
            yield cur_path
 
743
        # all done.
 
744
 
 
745
    def _get_inventory(self):
 
746
        return self._inventory
 
747
 
 
748
    inventory = property(_get_inventory,
 
749
                         doc="Inventory of this Tree")
 
750
 
 
751
    @needs_read_lock
 
752
    def path2id(self, path):
 
753
        """Return the id for path in this tree."""
 
754
        return self._inventory.path2id(path)
 
755
 
 
756
    def id2path(self, file_id):
 
757
        """Return the path for a file id.
 
758
 
 
759
        :raises NoSuchId:
 
760
        """
 
761
        return self.inventory.id2path(file_id)
 
762
 
 
763
    def has_id(self, file_id):
 
764
        return self.inventory.has_id(file_id)
 
765
 
 
766
    def has_or_had_id(self, file_id):
 
767
        return self.inventory.has_id(file_id)
 
768
 
 
769
    def all_file_ids(self):
 
770
        return set(self.inventory)
 
771
 
 
772
    @deprecated_method(deprecated_in((2, 4, 0)))
 
773
    def __iter__(self):
 
774
        return iter(self.inventory)
 
775
 
 
776
    def filter_unversioned_files(self, paths):
 
777
        """Filter out paths that are versioned.
 
778
 
 
779
        :return: set of paths.
 
780
        """
 
781
        # NB: we specifically *don't* call self.has_filename, because for
 
782
        # WorkingTrees that can indicate files that exist on disk but that
 
783
        # are not versioned.
 
784
        pred = self.inventory.has_filename
 
785
        return set((p for p in paths if not pred(p)))
 
786
 
 
787
    @needs_read_lock
 
788
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
789
        """Walk the tree in 'by_dir' order.
 
790
 
 
791
        This will yield each entry in the tree as a (path, entry) tuple.
 
792
        The order that they are yielded is:
 
793
 
 
794
        See Tree.iter_entries_by_dir for details.
 
795
 
 
796
        :param yield_parents: If True, yield the parents from the root leading
 
797
            down to specific_file_ids that have been requested. This has no
 
798
            impact if specific_file_ids is None.
 
799
        """
 
800
        return self.inventory.iter_entries_by_dir(
 
801
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
802
 
 
803
    def get_file_by_path(self, path):
 
804
        return self.get_file(self._inventory.path2id(path), path)
786
805
 
787
806
 
788
807
def find_ids_across_trees(filenames, trees, require_versioned=True):
795
814
        None)
796
815
    :param trees: The trees to find file_ids within
797
816
    :param require_versioned: if true, all specified filenames must occur in
798
 
    at least one tree.
 
817
        at least one tree.
799
818
    :return: a set of file ids for the specified filenames and their children.
800
819
    """
801
820
    if not filenames:
877
896
 
878
897
    _optimisers = []
879
898
 
 
899
    @classmethod
 
900
    def is_compatible(kls, source, target):
 
901
        # The default implementation is naive and uses the public API, so
 
902
        # it works for all trees.
 
903
        return True
 
904
 
880
905
    def _changes_from_entries(self, source_entry, target_entry,
881
906
        source_path=None, target_path=None):
882
907
        """Generate a iter_changes tuple between source_entry and target_entry.
987
1012
            # All files are unversioned, so just return an empty delta
988
1013
            # _compare_trees would think we want a complete delta
989
1014
            result = delta.TreeDelta()
990
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1015
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
991
1016
            result.unversioned = [(path, None,
992
1017
                self.target._comparison_data(fake_entry, path)[0]) for path in
993
1018
                specific_files]
1058
1083
                                     self.target.extras()
1059
1084
                if specific_files is None or
1060
1085
                    osutils.is_inside_any(specific_files, p)])
1061
 
            all_unversioned = deque(all_unversioned)
 
1086
            all_unversioned = collections.deque(all_unversioned)
1062
1087
        else:
1063
 
            all_unversioned = deque()
 
1088
            all_unversioned = collections.deque()
1064
1089
        to_paths = {}
1065
1090
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1066
1091
            specific_file_ids=specific_file_ids))
1072
1097
        # the unversioned path lookup only occurs on real trees - where there
1073
1098
        # can be extras. So the fake_entry is solely used to look up
1074
1099
        # executable it values when execute is not supported.
1075
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
1100
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1076
1101
        for target_path, target_entry in to_entries_by_dir:
1077
1102
            while (all_unversioned and
1078
1103
                all_unversioned[0][0] < target_path.split('/')):
1126
1151
            if file_id in to_paths:
1127
1152
                # already returned
1128
1153
                continue
1129
 
            if file_id not in self.target.all_file_ids():
 
1154
            if not self.target.has_id(file_id):
1130
1155
                # common case - paths we have not emitted are not present in
1131
1156
                # target.
1132
1157
                to_path = None
1251
1276
                    yield result
1252
1277
 
1253
1278
 
 
1279
InterTree.register_optimiser(InterTree)
 
1280
 
 
1281
 
1254
1282
class MultiWalker(object):
1255
1283
    """Walk multiple trees simultaneously, getting combined results."""
1256
1284