/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
5752.3.8 by John Arbash Meinel
Merge bzr.dev 5764 to resolve release-notes (aka NEWS) conflicts
1
# Copyright (C) 2005-2011 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
1 by mbp at sourcefrog
import from baz patch-364
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
1 by mbp at sourcefrog
import from baz patch-364
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
1 by mbp at sourcefrog
import from baz patch-364
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1 by mbp at sourcefrog
import from baz patch-364
16
17
"""Tree classes, representing directory at point in time.
18
"""
19
6379.6.7 by Jelmer Vernooij
Move importing from future until after doc string, otherwise the doc string will disappear.
20
from __future__ import absolute_import
21
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
22
from .lazy_import import lazy_import
5745.3.1 by Jelmer Vernooij
Use lazy imports in bzrlib.tree.
23
lazy_import(globals(), """
5745.3.4 by Jelmer Vernooij
Merge bzr.dev.
24
import collections
800 by Martin Pool
Merge John's import-speedup branch:
25
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
26
from breezy import (
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
27
    conflicts as _mod_conflicts,
3368.2.30 by Ian Clatworthy
add -Dfilters support
28
    debug,
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
29
    delta,
3368.2.16 by Ian Clatworthy
add real implementation of Tree.get_filter_stack
30
    filters,
1551.15.46 by Aaron Bentley
Move plan merge to tree
31
    revision as _mod_revision,
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
32
    rules,
5745.3.4 by Jelmer Vernooij
Merge bzr.dev.
33
    trace,
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
34
    )
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
35
from breezy.i18n import gettext
5745.3.1 by Jelmer Vernooij
Use lazy imports in bzrlib.tree.
36
""")
37
6731.1.1 by Jelmer Vernooij
Move FileTimestampUnavailable to breezy.tree.
38
from . import (
39
    errors,
6754.8.3 by Jelmer Vernooij
Use context manager in decorators.
40
    lock,
6731.1.1 by Jelmer Vernooij
Move FileTimestampUnavailable to breezy.tree.
41
    osutils,
42
    )
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
43
from .inter import InterObject
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
44
from .sixish import (
6973.6.2 by Jelmer Vernooij
Fix more tests.
45
    text_type,
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
46
    viewvalues,
47
    )
1 by mbp at sourcefrog
import from baz patch-364
48
1852.5.1 by Robert Collins
Deprecate EmptyTree in favour of using Repository.revision_tree.
49
6731.1.1 by Jelmer Vernooij
Move FileTimestampUnavailable to breezy.tree.
50
class FileTimestampUnavailable(errors.BzrError):
51
52
    _fmt = "The filestamp for %(path)s is not available."
53
54
    internal_error = True
55
56
    def __init__(self, path):
57
        self.path = path
58
59
6846.6.1 by Jelmer Vernooij
Move Tree{Link,File,Directory,Entry} to breezy.tree.
60
class TreeEntry(object):
61
    """An entry that implements the minimum interface used by commands.
62
    """
63
64
    def __eq__(self, other):
6857 by Jelmer Vernooij
Merge lp:~jelmer/brz/move-ie.
65
        # yes, this is ugly, TODO: best practice __eq__ style.
6846.6.1 by Jelmer Vernooij
Move Tree{Link,File,Directory,Entry} to breezy.tree.
66
        return (isinstance(other, TreeEntry)
67
                and other.__class__ == self.__class__)
68
69
    def kind_character(self):
70
        return "???"
71
72
73
class TreeDirectory(TreeEntry):
74
    """See TreeEntry. This is a directory in a working tree."""
75
76
    def kind_character(self):
77
        return "/"
78
79
80
class TreeFile(TreeEntry):
81
    """See TreeEntry. This is a regular file in a working tree."""
82
83
    def kind_character(self):
84
        return ''
85
86
87
class TreeLink(TreeEntry):
88
    """See TreeEntry. This is a symlink in a working tree."""
89
90
    def kind_character(self):
91
        return ''
92
93
6926.2.1 by Jelmer Vernooij
Some tree reference fixes.
94
class TreeReference(TreeEntry):
95
    """See TreeEntry. This is a reference to a nested tree in a working tree."""
96
97
    def kind_character(self):
7142.2.2 by Jelmer Vernooij
Fix kind character for tree references.
98
        return '+'
6926.2.1 by Jelmer Vernooij
Some tree reference fixes.
99
100
558 by Martin Pool
- All top-level classes inherit from object
101
class Tree(object):
1 by mbp at sourcefrog
import from baz patch-364
102
    """Abstract file tree.
103
104
    There are several subclasses:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
105
1 by mbp at sourcefrog
import from baz patch-364
106
    * `WorkingTree` exists as files on disk editable by the user.
107
108
    * `RevisionTree` is a tree as recorded at some point in the past.
109
110
    Trees can be compared, etc, regardless of whether they are working
111
    trees or versioned trees.
112
    """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
113
6883.5.17 by Jelmer Vernooij
Add Tree.supports_rename_tracking().
114
    def supports_rename_tracking(self):
115
        """Whether this tree supports rename tracking.
116
117
        This defaults to True, but some implementations may want to override
118
        it.
119
        """
120
        return True
121
6110.6.1 by Jelmer Vernooij
Add Tree.has_versioned_directories.
122
    def has_versioned_directories(self):
123
        """Whether this tree can contain explicitly versioned directories.
124
125
        This defaults to True, but some implementations may want to override
126
        it.
127
        """
128
        return True
129
1852.9.6 by Robert Collins
Merge the change from Tree.compare to Tree.changes_from.
130
    def changes_from(self, other, want_unchanged=False, specific_files=None,
7143.15.2 by Jelmer Vernooij
Run autopep8.
131
                     extra_trees=None, require_versioned=False, include_root=False,
132
                     want_unversioned=False):
1852.8.8 by Robert Collins
change Tree.compare to Tree.changes_from - its better for the common case.
133
        """Return a TreeDelta of the changes from other to this tree.
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
134
135
        :param other: A tree to compare with.
136
        :param specific_files: An optional list of file paths to restrict the
137
            comparison to. When mapping filenames to ids, all matches in all
138
            trees (including optional extra_trees) are used, and all children of
139
            matched directories are included.
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
140
        :param want_unchanged: An optional boolean requesting the inclusion of
141
            unchanged entries in the result.
142
        :param extra_trees: An optional list of additional trees to use when
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
143
            mapping the contents of specific_files (paths) to their identities.
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
144
        :param require_versioned: An optional boolean (defaults to False). When
145
            supplied and True all the 'specific_files' must be versioned, or
146
            a PathsNotVersionedError will be thrown.
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
147
        :param want_unversioned: Scan for unversioned paths.
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
148
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
149
        The comparison will be performed by an InterTree object looked up on
1852.8.4 by Robert Collins
Hook InterTree into Tree.
150
        self and other.
151
        """
1852.8.8 by Robert Collins
change Tree.compare to Tree.changes_from - its better for the common case.
152
        # Martin observes that Tree.changes_from returns a TreeDelta and this
153
        # may confuse people, because the class name of the returned object is
154
        # a synonym of the object referenced in the method name.
1852.9.6 by Robert Collins
Merge the change from Tree.compare to Tree.changes_from.
155
        return InterTree.get(other, self).compare(
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
156
            want_unchanged=want_unchanged,
157
            specific_files=specific_files,
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
158
            extra_trees=extra_trees,
159
            require_versioned=require_versioned,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
160
            include_root=include_root,
161
            want_unversioned=want_unversioned,
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
162
            )
2012.1.1 by Aaron Bentley
Implement change iterator
163
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
164
    def iter_changes(self, from_tree, include_unchanged=False,
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
165
                     specific_files=None, pb=None, extra_trees=None,
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
166
                     require_versioned=True, want_unversioned=False):
4988.10.6 by John Arbash Meinel
Fix bug #304182 by adding a trivial docstring to Tree.iter_changes
167
        """See InterTree.iter_changes"""
2012.1.5 by Aaron Bentley
Implement specific file id and dangling id handling
168
        intertree = InterTree.get(from_tree, self)
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
169
        return intertree.iter_changes(include_unchanged, specific_files, pb,
7143.15.2 by Jelmer Vernooij
Run autopep8.
170
                                      extra_trees, require_versioned, want_unversioned=want_unversioned)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
171
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
172
    def conflicts(self):
173
        """Get a list of the conflicts in the tree.
174
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
175
        Each conflict is an instance of breezy.conflicts.Conflict.
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
176
        """
2748.2.1 by Lukáš Lalinsky
Return ConflictsList() instead of [] from Tree.conflicts.
177
        return _mod_conflicts.ConflictList()
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
178
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
179
    def extras(self):
180
        """For trees that can have unversioned files, return all such paths."""
181
        return []
182
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
183
    def get_parent_ids(self):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
184
        """Get the parent ids for this tree.
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
185
186
        :return: a list of parent ids. [] is returned to indicate
187
        a tree with no parents.
188
        :raises: BzrError if the parents are not known.
189
        """
190
        raise NotImplementedError(self.get_parent_ids)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
191
1 by mbp at sourcefrog
import from baz patch-364
192
    def has_filename(self, filename):
193
        """True if the tree has given filename."""
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
194
        raise NotImplementedError(self.has_filename)
1 by mbp at sourcefrog
import from baz patch-364
195
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
196
    def is_ignored(self, filename):
197
        """Check whether the filename is ignored by this tree.
198
199
        :param filename: The relative filename within the tree.
200
        :return: True if the filename is ignored.
201
        """
202
        return False
203
3146.8.16 by Aaron Bentley
Updates from review
204
    def all_file_ids(self):
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
205
        """Iterate through all file ids, including ids for missing files."""
5837.2.1 by Jelmer Vernooij
Deprecate Tree.__iter__.
206
        raise NotImplementedError(self.all_file_ids)
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
207
6825.5.1 by Jelmer Vernooij
Implement Tree.all_versioned_paths.
208
    def all_versioned_paths(self):
209
        """Iterate through all paths, including paths for missing files."""
210
        raise NotImplementedError(self.all_versioned_paths)
211
1 by mbp at sourcefrog
import from baz patch-364
212
    def id2path(self, file_id):
2255.11.5 by Martin Pool
Tree.id2path should raise NoSuchId, not return None.
213
        """Return the path for a file id.
214
215
        :raises NoSuchId:
216
        """
5777.3.1 by Jelmer Vernooij
Split InventoryTree out of Tree.
217
        raise NotImplementedError(self.id2path)
1 by mbp at sourcefrog
import from baz patch-364
218
6929.6.1 by Jelmer Vernooij
Remove yield_parents argument to Tree.iter_entries_by_dir.
219
    def iter_entries_by_dir(self, specific_files=None):
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
220
        """Walk the tree in 'by_dir' order.
221
3363.2.23 by Aaron Bentley
Fix iter_entries_by_dir ordering
222
        This will yield each entry in the tree as a (path, entry) tuple.
223
        The order that they are yielded is:
224
225
        Directories are walked in a depth-first lexicographical order,
226
        however, whenever a directory is reached, all of its direct child
227
        nodes are yielded in  lexicographical order before yielding the
228
        grandchildren.
229
230
        For example, in the tree::
231
232
           a/
233
             b/
234
               c
235
             d/
236
               e
237
           f/
238
             g
239
3363.5.4 by Aaron Bentley
Fix iteration order of iter_entries_by_dir
240
        The yield order (ignoring root) would be::
5891.1.3 by Andrew Bennetts
Move docstring formatting fixes.
241
3363.2.23 by Aaron Bentley
Fix iter_entries_by_dir ordering
242
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
243
        """
5777.3.1 by Jelmer Vernooij
Split InventoryTree out of Tree.
244
        raise NotImplementedError(self.iter_entries_by_dir)
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
245
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
246
    def iter_child_entries(self, path):
6471.1.2 by Jelmer Vernooij
Add Tree.iter_child_entries.
247
        """Iterate over the children of a directory or tree reference.
248
6844.1.1 by Jelmer Vernooij
Many more foreign branch fixes.
249
        :param path: Path of the directory
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
250
        :raise NoSuchFile: When the path does not exist
6471.1.3 by Jelmer Vernooij
Add Tree.iter_child_entries.
251
        :return: Iterator over entries in the directory
6471.1.2 by Jelmer Vernooij
Add Tree.iter_child_entries.
252
        """
253
        raise NotImplementedError(self.iter_child_entries)
254
5793.2.1 by Jelmer Vernooij
Add Tree.list_files stub.
255
    def list_files(self, include_root=False, from_dir=None, recursive=True):
256
        """List all files in this tree.
257
258
        :param include_root: Whether to include the entry for the tree root
259
        :param from_dir: Directory under which to list files
260
        :param recursive: Whether to list files recursively
261
        :return: iterator over tuples of (path, versioned, kind, file_id,
262
            inventory entry)
263
        """
264
        raise NotImplementedError(self.list_files)
265
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
266
    def iter_references(self):
4370.3.2 by Ian Clatworthy
apply jam's review feedback
267
        if self.supports_tree_reference():
268
            for path, entry in self.iter_entries_by_dir():
269
                if entry.kind == 'tree-reference':
270
                    yield path, entry.file_id
2100.3.27 by Aaron Bentley
Enable nested commits
271
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
272
    def kind(self, path):
2255.2.159 by Martin Pool
reference-trees in dirstate pass all tests.
273
        raise NotImplementedError("Tree subclass %s must implement kind"
7143.15.2 by Jelmer Vernooij
Run autopep8.
274
                                  % self.__class__.__name__)
1465 by Robert Collins
Bugfix the new pull --clobber to not generate spurious conflicts.
275
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
276
    def stored_kind(self, path):
277
        """File kind stored for this path.
3146.8.4 by Aaron Bentley
Eliminate direct use of inventory from transform application
278
3146.8.15 by Aaron Bentley
Cleanup and docs
279
        May not match kind on disk for working trees.  Always available
280
        for versioned files, even when the file itself is missing.
3146.8.4 by Aaron Bentley
Eliminate direct use of inventory from transform application
281
        """
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
282
        return self.kind(path)
3146.8.4 by Aaron Bentley
Eliminate direct use of inventory from transform application
283
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
284
    def path_content_summary(self, path):
285
        """Get a summary of the information about path.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
286
4595.11.2 by Martin Pool
Clarify contract of path_content_summary
287
        All the attributes returned are for the canonical form, not the
288
        convenient form (if content filters are in use.)
289
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
290
        :param path: A relative path within the tree.
291
        :return: A tuple containing kind, size, exec, sha1-or-link.
292
            Kind is always present (see tree.kind()).
4595.11.13 by Martin Pool
Remove get_kind_and_executable_by_path; go back to using plain path_content_summary
293
            size is present if kind is file and the size of the 
294
                canonical form can be cheaply determined, None otherwise.
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
295
            exec is None unless kind is file and the platform supports the 'x'
296
                bit.
297
            sha1-or-link is the link target if kind is symlink, or the sha1 if
298
                it can be obtained without reading the file.
299
        """
300
        raise NotImplementedError(self.path_content_summary)
301
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
302
    def get_reference_revision(self, path):
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
303
        raise NotImplementedError("Tree subclass %s must implement "
304
                                  "get_reference_revision"
7143.15.2 by Jelmer Vernooij
Run autopep8.
305
                                  % self.__class__.__name__)
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
306
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
307
    def _comparison_data(self, entry, path):
2012.1.15 by Aaron Bentley
Minor tweaks
308
        """Return a tuple of kind, executable, stat_value for a file.
309
310
        entry may be None if there is no inventory entry for the file, but
311
        path must always be supplied.
312
313
        kind is None if there is no file present (even if an inventory id is
314
        present).  executable is False for non-file entries.
315
        """
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
316
        raise NotImplementedError(self._comparison_data)
317
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
318
    def get_file(self, path):
319
        """Return a file object for the file path in the tree.
2772.2.1 by Ian Clatworthy
(Ian Clatworthy) Quicker initial commit - skip SHAing twice & skip path lookup as we know it
320
        """
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
321
        raise NotImplementedError(self.get_file)
2255.7.36 by John Arbash Meinel
All trees should implement get_file_mtime()
322
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
323
    def get_file_with_stat(self, path):
324
        """Get a file handle and stat object for path.
4354.4.7 by Aaron Bentley
Move MutableTree.get_file_with_stat to Tree.get_file_with_stat.
325
326
        The default implementation returns (self.get_file, None) for backwards
327
        compatibility.
328
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
329
        :param path: The path of the file.
4354.4.7 by Aaron Bentley
Move MutableTree.get_file_with_stat to Tree.get_file_with_stat.
330
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
331
            no stat facility, or need for a stat cache feedback during commit,
332
            it may return None for the second element of the tuple.
333
        """
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
334
        return (self.get_file(path), None)
4354.4.5 by Aaron Bentley
Ensure Tree.get_file_with_stat is provided.
335
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
336
    def get_file_text(self, path):
3774.1.1 by Aaron Bentley
Test Tree.get_file_text() and supply default implementation.
337
        """Return the byte content of a file.
338
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
339
        :param path: The path of the file.
6006.3.1 by Martin Pool
Start adding ContentFilterTree
340
341
        :returns: A single byte string for the whole file.
3774.1.1 by Aaron Bentley
Test Tree.get_file_text() and supply default implementation.
342
        """
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
343
        with self.get_file(path) as my_file:
3774.1.1 by Aaron Bentley
Test Tree.get_file_text() and supply default implementation.
344
            return my_file.read()
345
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
346
    def get_file_lines(self, path):
3774.1.2 by Aaron Bentley
Test Tree.get_file_lines, provide a default implementation
347
        """Return the content of a file, as lines.
348
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
349
        :param path: The path of the file.
3774.1.2 by Aaron Bentley
Test Tree.get_file_lines, provide a default implementation
350
        """
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
351
        return osutils.split_lines(self.get_file_text(path))
3774.1.2 by Aaron Bentley
Test Tree.get_file_lines, provide a default implementation
352
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
353
    def get_file_verifier(self, path, stat_value=None):
5906.1.2 by Jelmer Vernooij
Add Tree.get_file_verifier.
354
        """Return a verifier for a file.
355
356
        The default implementation returns a sha1.
357
358
        :param path: The path that this file can be found at.
359
            These must point to the same object.
360
        :param stat_value: Optional stat value for the object
361
        :return: Tuple with verifier name and verifier data
362
        """
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
363
        return ("SHA1", self.get_file_sha1(path, stat_value=stat_value))
5906.1.2 by Jelmer Vernooij
Add Tree.get_file_verifier.
364
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
365
    def get_file_sha1(self, path, stat_value=None):
5777.1.3 by Jelmer Vernooij
Add stub for Tree.get_file_sha1.
366
        """Return the SHA1 file for a file.
367
5906.1.4 by Jelmer Vernooij
Add InterTree.file_contents_match.
368
        :note: callers should use get_file_verifier instead
369
            where possible, as the underlying repository implementation may
370
            have quicker access to a non-sha1 verifier.
371
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
372
        :param path: The path that this file can be found at.
5883.1.2 by Jelmer Vernooij
Support stat_value argument to get_file_sha1
373
        :param stat_value: Optional stat value for the object
5777.1.3 by Jelmer Vernooij
Add stub for Tree.get_file_sha1.
374
        """
375
        raise NotImplementedError(self.get_file_sha1)
376
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
377
    def get_file_mtime(self, path):
2255.7.36 by John Arbash Meinel
All trees should implement get_file_mtime()
378
        """Return the modification time for a file.
379
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
380
        :param path: The path that this file can be found at.
2255.7.36 by John Arbash Meinel
All trees should implement get_file_mtime()
381
        """
382
        raise NotImplementedError(self.get_file_mtime)
383
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
384
    def get_file_size(self, path):
3363.3.4 by Aaron Bentley
Add get_file_size to Tree interface
385
        """Return the size of a file in bytes.
386
387
        This applies only to regular files.  If invoked on directories or
388
        symlinks, it will return None.
389
        """
390
        raise NotImplementedError(self.get_file_size)
391
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
392
    def is_executable(self, path):
5777.1.4 by Jelmer Vernooij
Stub for is_executable.
393
        """Check if a file is executable.
394
6809.4.4 by Jelmer Vernooij
Swap arguments for Tree.is_executable.
395
        :param path: The path that this file can be found at.
5777.1.4 by Jelmer Vernooij
Stub for is_executable.
396
        """
397
        raise NotImplementedError(self.is_executable)
398
2708.1.7 by Aaron Bentley
Rename extract_files_bytes to iter_files_bytes
399
    def iter_files_bytes(self, desired_files):
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
400
        """Iterate through file contents.
2708.1.1 by Aaron Bentley
Implement Tree.extract_files
401
2708.1.10 by Aaron Bentley
Update docstrings
402
        Files will not necessarily be returned in the order they occur in
403
        desired_files.  No specific order is guaranteed.
404
405
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
406
        value supplied by the caller as part of desired_files.  It should
407
        uniquely identify the file version in the caller's context.  (Examples:
408
        an index number or a TreeTransform trans_id.)
409
410
        bytes_iterator is an iterable of bytestrings for the file.  The
411
        kind of iterable and length of the bytestrings are unspecified, but for
412
        this implementation, it is a tuple containing a single bytestring with
413
        the complete text of the file.
414
6874.2.1 by Jelmer Vernooij
Make Tree.iter_files_bytes() take paths rather than file_ids.
415
        :param desired_files: a list of (path, identifier) pairs
2708.1.1 by Aaron Bentley
Implement Tree.extract_files
416
        """
6874.2.1 by Jelmer Vernooij
Make Tree.iter_files_bytes() take paths rather than file_ids.
417
        for path, identifier in desired_files:
2708.1.10 by Aaron Bentley
Update docstrings
418
            # We wrap the string in a tuple so that we can return an iterable
419
            # of bytestrings.  (Technically, a bytestring is also an iterable
420
            # of bytestrings, but iterating through each character is not
421
            # performant.)
6874.2.1 by Jelmer Vernooij
Make Tree.iter_files_bytes() take paths rather than file_ids.
422
            cur_file = (self.get_file_text(path),)
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
423
            yield identifier, cur_file
2708.1.1 by Aaron Bentley
Implement Tree.extract_files
424
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
425
    def get_symlink_target(self, path):
426
        """Get the target for a given path.
2255.2.134 by John Arbash Meinel
Add a tree-test for get_symlink_target
427
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
428
        It is assumed that the caller already knows that path is referencing
2255.2.134 by John Arbash Meinel
Add a tree-test for get_symlink_target
429
        a symlink.
5858.1.1 by Jelmer Vernooij
Support optional path argument to Tree.get_symlink_target.
430
        :param path: The path of the file.
2255.2.134 by John Arbash Meinel
Add a tree-test for get_symlink_target
431
        :return: The path the symlink points to.
432
        """
433
        raise NotImplementedError(self.get_symlink_target)
434
2946.3.2 by John Arbash Meinel
Add tree implementation tests for Tree.get_root_id()
435
    def get_root_id(self):
436
        """Return the file_id for the root of this tree."""
437
        raise NotImplementedError(self.get_root_id)
438
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
439
    def annotate_iter(self, path,
3224.1.2 by John Arbash Meinel
Updated the base Tree.annotate_iter() since all implemenations take an optional kwarg.
440
                      default_revision=_mod_revision.CURRENT_REVISION):
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
441
        """Return an iterator of revision_id, line tuples.
1551.9.18 by Aaron Bentley
Updates from review comments
442
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
443
        For working trees (and mutable trees in general), the special
444
        revision_id 'current:' will be used for lines that are new in this
445
        tree, e.g. uncommitted changes.
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
446
        :param path: The file to produce an annotated version from
3224.1.2 by John Arbash Meinel
Updated the base Tree.annotate_iter() since all implemenations take an optional kwarg.
447
        :param default_revision: For lines that don't match a basis, mark them
448
            with this revision id. Not all implementations will make use of
449
            this value.
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
450
        """
451
        raise NotImplementedError(self.annotate_iter)
452
3363.9.1 by Aaron Bentley
Implement plan_merge, refactoring various bits
453
    def _iter_parent_trees(self):
454
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
455
        for revision_id in self.get_parent_ids():
456
            try:
457
                yield self.revision_tree(revision_id)
458
            except errors.NoSuchRevisionInTree:
459
                yield self.repository.revision_tree(revision_id)
460
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
461
    def path2id(self, path):
462
        """Return the id for path in this tree."""
5777.3.1 by Jelmer Vernooij
Split InventoryTree out of Tree.
463
        raise NotImplementedError(self.path2id)
1 by mbp at sourcefrog
import from baz patch-364
464
6852.3.1 by Jelmer Vernooij
add Tree.is_versioned.
465
    def is_versioned(self, path):
466
        """Check whether path is versioned.
467
468
        :param path: Path to check
469
        :return: boolean
470
        """
6856 by Jelmer Vernooij
Merge lp:~jelmer/brz/is-versioned.
471
        return self.path2id(path) is not None
6852.3.1 by Jelmer Vernooij
add Tree.is_versioned.
472
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
473
    def find_related_paths_across_trees(self, paths, trees=[],
7143.15.2 by Jelmer Vernooij
Run autopep8.
474
                                        require_versioned=True):
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
475
        """Find related paths in tree corresponding to specified filenames in any
476
        of `lookup_trees`.
477
478
        All matches in all trees will be used, and all children of matched
479
        directories will be used.
480
481
        :param paths: The filenames to find related paths for (if None, returns
482
            None)
483
        :param trees: The trees to find file_ids within
484
        :param require_versioned: if true, all specified filenames must occur in
485
            at least one tree.
486
        :return: a set of paths for the specified filenames and their children
487
            in `tree`
488
        """
6885.5.4 by Jelmer Vernooij
Move paths2ids to InventoryTree.
489
        raise NotImplementedError(self.find_related_paths_across_trees)
3363.12.2 by Aaron Bentley
Implement tree.iter_children to instead of adjusting InventoryEntry handling
490
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
491
    def lock_read(self):
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
492
        """Lock this tree for multiple read only operations.
6468.3.1 by Jelmer Vernooij
Use iter_children in a couple more places.
493
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
494
        :return: A breezy.lock.LogicalLockResult.
5200.3.6 by Robert Collins
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.
495
        """
6754.8.3 by Jelmer Vernooij
Use context manager in decorators.
496
        return lock.LogicalLockResult(self.unlock)
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
497
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
498
    def revision_tree(self, revision_id):
499
        """Obtain a revision tree for the revision revision_id.
500
501
        The intention of this method is to allow access to possibly cached
502
        tree data. Implementors of this method should raise NoSuchRevision if
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
503
        the tree is not locally available, even if they could obtain the
504
        tree via a repository or some other means. Callers are responsible
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
505
        for finding the ultimate source for a revision tree.
506
507
        :param revision_id: The revision_id of the requested tree.
508
        :return: A Tree.
509
        :raises: NoSuchRevision if the tree cannot be obtained.
510
        """
511
        raise errors.NoSuchRevisionInTree(self, revision_id)
512
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
513
    def unknowns(self):
514
        """What files are present in this tree and unknown.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
515
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
516
        :return: an iterator over the unknown files.
517
        """
518
        return iter([])
519
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
520
    def unlock(self):
521
        pass
1658.1.9 by Martin Pool
Give an error for bzr diff on an nonexistent file (Malone #3619)
522
523
    def filter_unversioned_files(self, paths):
2255.7.62 by Robert Collins
Update the Tree.filter_unversioned_files docstring to reflect what the existing implementations actually do, and change the WorkingTree4 implementation to match a newly created test for it.
524
        """Filter out paths that are versioned.
1658.1.9 by Martin Pool
Give an error for bzr diff on an nonexistent file (Malone #3619)
525
526
        :return: set of paths.
527
        """
6974.1.1 by Jelmer Vernooij
Provide a sensible default implementaton of Tree.filter_unversioned_files.
528
        # NB: we specifically *don't* call self.has_filename, because for
529
        # WorkingTrees that can indicate files that exist on disk but that
530
        # are not versioned.
6974.1.2 by Jelmer Vernooij
Avoid unnecessary parentheses.
531
        return set(p for p in paths if not self.is_versioned(p))
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
532
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
533
    def walkdirs(self, prefix=""):
534
        """Walk the contents of this tree from path down.
535
536
        This yields all the data about the contents of a directory at a time.
537
        After each directory has been yielded, if the caller has mutated the
538
        list to exclude some directories, they are then not descended into.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
539
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
540
        The data yielded is of the form:
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
541
        ((directory-relpath, directory-path-from-root, directory-fileid),
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
542
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id,
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
543
          versioned_kind), ...]),
544
         - directory-relpath is the containing dirs relpath from prefix
545
         - directory-path-from-root is the containing dirs path from /
546
         - directory-fileid is the id of the directory if it is versioned.
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
547
         - relpath is the relative path within the subtree being walked.
548
         - basename is the basename
549
         - kind is the kind of the file now. If unknonwn then the file is not
550
           present within the tree - but it may be recorded as versioned. See
551
           versioned_kind.
552
         - lstat is the stat data *if* the file was statted.
553
         - path_from_tree_root is the path from the root of the tree.
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
554
         - file_id is the file_id if the entry is versioned.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
555
         - versioned_kind is the kind of the file as last recorded in the
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
556
           versioning system. If 'unknown' the file is not versioned.
557
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
558
559
        :param prefix: Start walking from prefix within the tree rather than
560
        at the root. This allows one to walk a subtree but get paths that are
561
        relative to a tree rooted higher up.
562
        :return: an iterator over the directory data.
563
        """
564
        raise NotImplementedError(self.walkdirs)
565
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
566
    def supports_content_filtering(self):
567
        return False
568
6883.5.3 by Jelmer Vernooij
Add find_previous_path.
569
    def _content_filter_stack(self, path=None):
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
570
        """The stack of content filters for a path if filtering is supported.
3368.2.47 by Ian Clatworthy
merge bzr.dev r4042
571
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
572
        Readers will be applied in first-to-last order.
573
        Writers will be applied in last-to-first order.
3368.2.5 by Ian Clatworthy
incorporate jameinel's review feedback
574
        Either the path or the file-id needs to be provided.
575
576
        :param path: path relative to the root of the tree
577
            or None if unknown
578
        :return: the list of filters - [] if there are none
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
579
        """
3368.2.16 by Ian Clatworthy
add real implementation of Tree.get_filter_stack
580
        filter_pref_names = filters._get_registered_names()
581
        if len(filter_pref_names) == 0:
582
            return []
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
583
        prefs = next(self.iter_search_rules([path], filter_pref_names))
3368.2.30 by Ian Clatworthy
add -Dfilters support
584
        stk = filters._get_filter_stack_for(prefs)
585
        if 'filters' in debug.debug_flags:
7143.15.2 by Jelmer Vernooij
Run autopep8.
586
            trace.note(
587
                gettext("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk))
3368.2.30 by Ian Clatworthy
add -Dfilters support
588
        return stk
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
589
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
590
    def _content_filter_stack_provider(self):
591
        """A function that returns a stack of ContentFilters.
592
593
        The function takes a path (relative to the top of the tree) and a
594
        file-id as parameters.
595
596
        :return: None if content filtering is not supported by this tree.
597
        """
598
        if self.supports_content_filtering():
599
            return lambda path, file_id: \
7143.15.2 by Jelmer Vernooij
Run autopep8.
600
                self._content_filter_stack(path)
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
601
        else:
602
            return None
603
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
604
    def iter_search_rules(self, path_names, pref_names=None,
7143.15.2 by Jelmer Vernooij
Run autopep8.
605
                          _default_searcher=None):
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
606
        """Find the preferences for filenames in a tree.
607
608
        :param path_names: an iterable of paths to find attributes for.
609
          Paths are given relative to the root of the tree.
610
        :param pref_names: the list of preferences to lookup - None for all
611
        :param _default_searcher: private parameter to assist testing - don't use
612
        :return: an iterator of tuple sequences, one per path-name.
613
          See _RulesSearcher.get_items for details on the tuple sequence.
614
        """
4324.4.1 by Marius Kruger
Make it possible to blackboxtest rules
615
        if _default_searcher is None:
616
            _default_searcher = rules._per_user_searcher
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
617
        searcher = self._get_rules_searcher(_default_searcher)
618
        if searcher is not None:
3398.1.34 by Ian Clatworthy
changed API design as requested by jam during review
619
            if pref_names is not None:
620
                for path in path_names:
621
                    yield searcher.get_selected_items(path, pref_names)
622
            else:
623
                for path in path_names:
624
                    yield searcher.get_items(path)
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
625
626
    def _get_rules_searcher(self, default_searcher):
627
        """Get the RulesSearcher for this tree given the default one."""
628
        searcher = default_searcher
629
        return searcher
630
6968.2.7 by Jelmer Vernooij
Add breezy.archive.
631
    def archive(self, format, name, root='', subdir=None,
632
                force_mtime=None):
6968.2.1 by Jelmer Vernooij
Add Tree.archive, which streams an archived version of a tree.
633
        """Create an archive of this tree.
634
6995 by Jelmer Vernooij
Merge lp:~jelmer/brz/hpss-archive.
635
        :param format: Format name (e.g. 'tar')
6968.2.1 by Jelmer Vernooij
Add Tree.archive, which streams an archived version of a tree.
636
        :param name: target file name
637
        :param root: Root directory name (or None)
638
        :param subdir: Subdirectory to export (or None)
639
        :return: Iterator over archive chunks
640
        """
6968.2.10 by Jelmer Vernooij
Review comments.
641
        from .archive import create_archive
6968.2.1 by Jelmer Vernooij
Add Tree.archive, which streams an archived version of a tree.
642
        with self.lock_read():
6968.2.7 by Jelmer Vernooij
Add breezy.archive.
643
            return create_archive(format, self, name, root,
7143.15.2 by Jelmer Vernooij
Run autopep8.
644
                                  subdir, force_mtime=force_mtime)
6968.2.1 by Jelmer Vernooij
Add Tree.archive, which streams an archived version of a tree.
645
6929.3.3 by Jelmer Vernooij
Add Tree.versionable_kind.
646
    @classmethod
647
    def versionable_kind(cls, kind):
648
        """Check if this tree support versioning a specific file kind."""
649
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
650
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
651
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
652
class InterTree(InterObject):
653
    """This class represents operations taking place between two Trees.
654
655
    Its instances have methods like 'compare' and contain references to the
656
    source and target trees these operations are to be carried out on.
657
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
658
    Clients of breezy should not need to use InterTree directly, rather they
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
659
    should use the convenience methods on Tree such as 'Tree.compare()' which
660
    will pass through to InterTree as appropriate.
661
    """
662
4585.1.18 by Jelmer Vernooij
Add note saying that InterTree will not be tested if the from and to formats are not set.
663
    # Formats that will be used to test this InterTree. If both are
664
    # None, this InterTree will not be tested (e.g. because a complex
665
    # setup is required)
666
    _matching_from_tree_format = None
667
    _matching_to_tree_format = None
668
1910.2.15 by Aaron Bentley
Back out inter.get changes, make optimizers an ordered list
669
    _optimisers = []
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
670
5837.1.2 by Jelmer Vernooij
Register defaults as first optimiser for existing Inter objects.
671
    @classmethod
672
    def is_compatible(kls, source, target):
673
        # The default implementation is naive and uses the public API, so
674
        # it works for all trees.
675
        return True
676
6883.1.1 by Jelmer Vernooij
Avoid file id lookups.
677
    def _changes_from_entries(self, source_entry, target_entry, source_path,
678
                              target_path):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
679
        """Generate a iter_changes tuple between source_entry and target_entry.
680
681
        :param source_entry: An inventory entry from self.source, or None.
682
        :param target_entry: An inventory entry from self.target, or None.
6883.1.1 by Jelmer Vernooij
Avoid file id lookups.
683
        :param source_path: The path of source_entry.
684
        :param target_path: The path of target_entry.
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
685
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
686
            item 1 is True if there are any changes in the result tuple.
687
        """
688
        if source_entry is None:
689
            if target_entry is None:
690
                return None
691
            file_id = target_entry.file_id
692
        else:
693
            file_id = source_entry.file_id
694
        if source_entry is not None:
695
            source_versioned = True
696
            source_name = source_entry.name
697
            source_parent = source_entry.parent_id
698
            source_kind, source_executable, source_stat = \
699
                self.source._comparison_data(source_entry, source_path)
700
        else:
701
            source_versioned = False
702
            source_name = None
703
            source_parent = None
704
            source_kind = None
705
            source_executable = None
706
        if target_entry is not None:
707
            target_versioned = True
708
            target_name = target_entry.name
709
            target_parent = target_entry.parent_id
710
            target_kind, target_executable, target_stat = \
711
                self.target._comparison_data(target_entry, target_path)
712
        else:
713
            target_versioned = False
714
            target_name = None
715
            target_parent = None
716
            target_kind = None
717
            target_executable = None
718
        versioned = (source_versioned, target_versioned)
719
        kind = (source_kind, target_kind)
720
        changed_content = False
721
        if source_kind != target_kind:
722
            changed_content = True
723
        elif source_kind == 'file':
6883.7.1 by Jelmer Vernooij
Swap order of arguments to Tree.file_content_matches.
724
            if not self.file_content_matches(
6883.1.2 by Jelmer Vernooij
Fix order.
725
                    source_path, target_path,
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
726
                    source_stat, target_stat):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
727
                changed_content = True
728
        elif source_kind == 'symlink':
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
729
            if (self.source.get_symlink_target(source_path) !=
7143.16.21 by Jelmer Vernooij
Fix regressions.
730
                    self.target.get_symlink_target(target_path)):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
731
                changed_content = True
6405.2.12 by Jelmer Vernooij
Fix tests.
732
        elif source_kind == 'tree-reference':
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
733
            if (self.source.get_reference_revision(source_path)
7143.16.21 by Jelmer Vernooij
Fix regressions.
734
                    != self.target.get_reference_revision(target_path)):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
735
                    changed_content = True
736
        parent = (source_parent, target_parent)
737
        name = (source_name, target_name)
738
        executable = (source_executable, target_executable)
7143.15.2 by Jelmer Vernooij
Run autopep8.
739
        if (changed_content is not False or versioned[0] != versioned[1] or
740
            parent[0] != parent[1] or name[0] != name[1] or
741
                executable[0] != executable[1]):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
742
            changes = True
743
        else:
744
            changes = False
745
        return (file_id, (source_path, target_path), changed_content,
746
                versioned, parent, name, kind, executable), changes
747
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
748
    def compare(self, want_unchanged=False, specific_files=None,
7143.15.2 by Jelmer Vernooij
Run autopep8.
749
                extra_trees=None, require_versioned=False, include_root=False,
750
                want_unversioned=False):
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
751
        """Return the changes from source to target.
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
752
753
        :return: A TreeDelta.
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
754
        :param specific_files: An optional list of file paths to restrict the
755
            comparison to. When mapping filenames to ids, all matches in all
756
            trees (including optional extra_trees) are used, and all children of
757
            matched directories are included.
758
        :param want_unchanged: An optional boolean requesting the inclusion of
759
            unchanged entries in the result.
760
        :param extra_trees: An optional list of additional trees to use when
761
            mapping the contents of specific_files (paths) to file_ids.
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
762
        :param require_versioned: An optional boolean (defaults to False). When
763
            supplied and True all the 'specific_files' must be versioned, or
764
            a PathsNotVersionedError will be thrown.
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
765
        :param want_unversioned: Scan for unversioned paths.
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
766
        """
2255.2.105 by Robert Collins
Unfuck InterTree.compare which I broke with the paths2ids implementation.
767
        trees = (self.source,)
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
768
        if extra_trees is not None:
769
            trees = trees + tuple(extra_trees)
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
770
        with self.lock_read():
771
            return delta._compare_trees(self.source, self.target, want_unchanged,
7143.15.2 by Jelmer Vernooij
Run autopep8.
772
                                        specific_files, include_root, extra_trees=extra_trees,
773
                                        require_versioned=require_versioned,
774
                                        want_unversioned=want_unversioned)
2012.1.1 by Aaron Bentley
Implement change iterator
775
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
776
    def iter_changes(self, include_unchanged=False,
7143.15.2 by Jelmer Vernooij
Run autopep8.
777
                     specific_files=None, pb=None, extra_trees=[],
778
                     require_versioned=True, want_unversioned=False):
2012.1.1 by Aaron Bentley
Implement change iterator
779
        """Generate an iterator of changes between trees.
780
781
        A tuple is returned:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
782
        (file_id, (path_in_source, path_in_target),
783
         changed_content, versioned, parent, name, kind,
2012.1.1 by Aaron Bentley
Implement change iterator
784
         executable)
785
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
786
        Changed_content is True if the file's content has changed.  This
787
        includes changes to its kind, and to a symlink's target.
2012.1.1 by Aaron Bentley
Implement change iterator
788
2012.1.15 by Aaron Bentley
Minor tweaks
789
        versioned, parent, name, kind, executable are tuples of (from, to).
790
        If a file is missing in a tree, its kind is None.
2012.1.1 by Aaron Bentley
Implement change iterator
791
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
792
        Iteration is done in parent-to-child order, relative to the target
793
        tree.
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
794
795
        There is no guarantee that all paths are in sorted order: the
796
        requirement to expand the search due to renames may result in children
797
        that should be found early being found late in the search, after
798
        lexically later results have been returned.
799
        :param require_versioned: Raise errors.PathsNotVersionedError if a
800
            path in the specific_files list is not versioned in one of
801
            source, target or extra_trees.
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
802
        :param specific_files: An optional list of file paths to restrict the
803
            comparison to. When mapping filenames to ids, all matches in all
804
            trees (including optional extra_trees) are used, and all children
805
            of matched directories are included. The parents in the target tree
806
            of the specific files up to and including the root of the tree are
807
            always evaluated for changes too.
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
808
        :param want_unversioned: Should unversioned files be returned in the
809
            output. An unversioned file is defined as one with (False, False)
810
            for the versioned pair.
2012.1.1 by Aaron Bentley
Implement change iterator
811
        """
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
812
        if not extra_trees:
7143.15.2 by Jelmer Vernooij
Run autopep8.
813
            extra_trees = []
6885.5.8 by Jelmer Vernooij
Remove interesting_ids support from merge.
814
        else:
7143.15.2 by Jelmer Vernooij
Run autopep8.
815
            extra_trees = list(extra_trees)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
816
        # The ids of items we need to examine to insure delta consistency.
817
        precise_file_ids = set()
818
        changed_file_ids = []
2748.3.1 by Aaron Bentley
Start supporting [] for empty list
819
        if specific_files == []:
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
820
            target_specific_files = []
821
            source_specific_files = []
2748.3.1 by Aaron Bentley
Start supporting [] for empty list
822
        else:
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
823
            target_specific_files = self.target.find_related_paths_across_trees(
7143.15.2 by Jelmer Vernooij
Run autopep8.
824
                specific_files, [self.source] + extra_trees,
825
                require_versioned=require_versioned)
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
826
            source_specific_files = self.source.find_related_paths_across_trees(
7143.15.2 by Jelmer Vernooij
Run autopep8.
827
                specific_files, [self.target] + extra_trees,
828
                require_versioned=require_versioned)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
829
        if specific_files is not None:
830
            # reparented or added entries must have their parents included
831
            # so that valid deltas can be created. The seen_parents set
832
            # tracks the parents that we need to have.
833
            # The seen_dirs set tracks directory entries we've yielded.
834
            # After outputting version object in to_entries we set difference
835
            # the two seen sets and start checking parents.
836
            seen_parents = set()
837
            seen_dirs = set()
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
838
        if want_unversioned:
2748.3.1 by Aaron Bentley
Start supporting [] for empty list
839
            all_unversioned = sorted([(p.split('/'), p) for p in
7143.15.2 by Jelmer Vernooij
Run autopep8.
840
                                      self.target.extras()
841
                                      if specific_files is None or
842
                                      osutils.is_inside_any(specific_files, p)])
5745.3.4 by Jelmer Vernooij
Merge bzr.dev.
843
            all_unversioned = collections.deque(all_unversioned)
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
844
        else:
5745.3.4 by Jelmer Vernooij
Merge bzr.dev.
845
            all_unversioned = collections.deque()
2012.1.1 by Aaron Bentley
Implement change iterator
846
        to_paths = {}
3363.14.2 by Aaron Bentley
Get iter_changes running to completion
847
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
848
            specific_files=source_specific_files))
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
849
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
3363.14.2 by Aaron Bentley
Get iter_changes running to completion
850
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
851
            specific_files=target_specific_files))
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
852
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
853
        entry_count = 0
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
854
        # the unversioned path lookup only occurs on real trees - where there
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
855
        # can be extras. So the fake_entry is solely used to look up
856
        # executable it values when execute is not supported.
6929.3.2 by Jelmer Vernooij
Remove use of inventory in breezy.tree.
857
        fake_entry = TreeFile()
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
858
        for target_path, target_entry in to_entries_by_dir:
859
            while (all_unversioned and
7143.15.2 by Jelmer Vernooij
Run autopep8.
860
                   all_unversioned[0][0] < target_path.split('/')):
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
861
                unversioned_path = all_unversioned.popleft()
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
862
                target_kind, target_executable, target_stat = \
7143.15.2 by Jelmer Vernooij
Run autopep8.
863
                    self.target._comparison_data(
864
                        fake_entry, unversioned_path[1])
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
865
                yield (None, (None, unversioned_path[1]), True, (False, False),
7143.15.2 by Jelmer Vernooij
Run autopep8.
866
                       (None, None),
867
                       (None, unversioned_path[0][-1]),
868
                       (None, target_kind),
869
                       (None, target_executable))
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
870
            source_path, source_entry = from_data.get(target_entry.file_id,
7143.15.2 by Jelmer Vernooij
Run autopep8.
871
                                                      (None, None))
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
872
            result, changes = self._changes_from_entries(source_entry,
7143.15.2 by Jelmer Vernooij
Run autopep8.
873
                                                         target_entry, source_path=source_path, target_path=target_path)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
874
            to_paths[result[0]] = result[1][1]
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
875
            entry_count += 1
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
876
            if result[3][0]:
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
877
                entry_count += 1
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
878
            if pb is not None:
879
                pb.update('comparing files', entry_count, num_entries)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
880
            if changes or include_unchanged:
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
881
                if specific_files is not None:
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
882
                    new_parent_id = result[4][1]
883
                    precise_file_ids.add(new_parent_id)
884
                    changed_file_ids.append(result[0])
885
                yield result
886
            # Ensure correct behaviour for reparented/added specific files.
887
            if specific_files is not None:
888
                # Record output dirs
889
                if result[6][1] == 'directory':
890
                    seen_dirs.add(result[0])
891
                # Record parents of reparented/added entries.
892
                versioned = result[3]
893
                parents = result[4]
894
                if not versioned[0] or parents[0] != parents[1]:
895
                    seen_parents.add(parents[1])
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
896
        while all_unversioned:
897
            # yield any trailing unversioned paths
898
            unversioned_path = all_unversioned.popleft()
899
            to_kind, to_executable, to_stat = \
900
                self.target._comparison_data(fake_entry, unversioned_path[1])
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
901
            yield (None, (None, unversioned_path[1]), True, (False, False),
7143.15.2 by Jelmer Vernooij
Run autopep8.
902
                   (None, None),
903
                   (None, unversioned_path[0][-1]),
904
                   (None, to_kind),
905
                   (None, to_executable))
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
906
        # Yield all remaining source paths
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
907
        for path, from_entry in from_entries_by_dir:
2012.1.1 by Aaron Bentley
Implement change iterator
908
            file_id = from_entry.file_id
909
            if file_id in to_paths:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
910
                # already returned
2012.1.1 by Aaron Bentley
Implement change iterator
911
                continue
6883.5.3 by Jelmer Vernooij
Add find_previous_path.
912
            to_path = find_previous_path(self.source, self.target, path)
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
913
            entry_count += 1
914
            if pb is not None:
915
                pb.update('comparing files', entry_count, num_entries)
2012.1.1 by Aaron Bentley
Implement change iterator
916
            versioned = (True, False)
917
            parent = (from_entry.parent_id, None)
918
            name = (from_entry.name, None)
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
919
            from_kind, from_executable, stat_value = \
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
920
                self.source._comparison_data(from_entry, path)
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
921
            kind = (from_kind, None)
2012.1.2 by Aaron Bentley
reimplement compare_trees
922
            executable = (from_executable, None)
3619.4.1 by Robert Collins
Improve tests for the behaviour of Tree.iter_changes for missing paths that are only present in one tree, and fix found bugs. (Robert Collins)
923
            changed_content = from_kind is not None
2012.1.1 by Aaron Bentley
Implement change iterator
924
            # the parent's path is necessarily known at this point.
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
925
            changed_file_ids.append(file_id)
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
926
            yield(file_id, (path, to_path), changed_content, versioned, parent,
2012.1.1 by Aaron Bentley
Implement change iterator
927
                  name, kind, executable)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
928
        changed_file_ids = set(changed_file_ids)
6885.5.3 by Jelmer Vernooij
Add a Tree.find_related_paths_across_trees.
929
        if specific_files is not None:
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
930
            for result in self._handle_precise_ids(precise_file_ids,
7143.15.2 by Jelmer Vernooij
Run autopep8.
931
                                                   changed_file_ids):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
932
                yield result
933
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
934
    def _get_entry(self, tree, path):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
935
        """Get an inventory entry from a tree, with missing entries as None.
936
937
        If the tree raises NotImplementedError on accessing .inventory, then
938
        this is worked around using iter_entries_by_dir on just the file id
939
        desired.
940
941
        :param tree: The tree to lookup the entry in.
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
942
        :param path: The path to look up
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
943
        """
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
944
        # No inventory available.
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
945
        try:
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
946
            iterator = tree.iter_entries_by_dir(specific_files=[path])
6973.7.5 by Jelmer Vernooij
s/file/open.
947
            return next(iterator)[1]
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
948
        except StopIteration:
949
            return None
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
950
951
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
7143.15.2 by Jelmer Vernooij
Run autopep8.
952
                            discarded_changes=None):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
953
        """Fill out a partial iter_changes to be consistent.
954
955
        :param precise_file_ids: The file ids of parents that were seen during
956
            the iter_changes.
957
        :param changed_file_ids: The file ids of already emitted items.
958
        :param discarded_changes: An optional dict of precalculated
959
            iter_changes items which the partial iter_changes had not output
960
            but had calculated.
961
        :return: A generator of iter_changes items to output.
962
        """
963
        # process parents of things that had changed under the users
964
        # requested paths to prevent incorrect paths or parent ids which
965
        # aren't in the tree.
966
        while precise_file_ids:
967
            precise_file_ids.discard(None)
968
            # Don't emit file_ids twice
969
            precise_file_ids.difference_update(changed_file_ids)
970
            if not precise_file_ids:
971
                break
972
            # If the there was something at a given output path in source, we
973
            # have to include the entry from source in the delta, or we would
974
            # be putting this entry into a used path.
975
            paths = []
976
            for parent_id in precise_file_ids:
977
                try:
978
                    paths.append(self.target.id2path(parent_id))
979
                except errors.NoSuchId:
980
                    # This id has been dragged in from the source by delta
981
                    # expansion and isn't present in target at all: we don't
982
                    # need to check for path collisions on it.
983
                    pass
984
            for path in paths:
985
                old_id = self.source.path2id(path)
986
                precise_file_ids.add(old_id)
987
            precise_file_ids.discard(None)
988
            current_ids = precise_file_ids
989
            precise_file_ids = set()
990
            # We have to emit all of precise_file_ids that have been altered.
991
            # We may have to output the children of some of those ids if any
992
            # directories have stopped being directories.
993
            for file_id in current_ids:
994
                # Examine file_id
995
                if discarded_changes:
996
                    result = discarded_changes.get(file_id)
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
997
                    source_entry = None
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
998
                else:
999
                    result = None
1000
                if result is None:
6883.1.4 by Jelmer Vernooij
Fix tests.
1001
                    try:
1002
                        source_path = self.source.id2path(file_id)
1003
                    except errors.NoSuchId:
1004
                        source_path = None
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
1005
                        source_entry = None
1006
                    else:
7143.15.2 by Jelmer Vernooij
Run autopep8.
1007
                        source_entry = self._get_entry(
1008
                            self.source, source_path)
6883.1.4 by Jelmer Vernooij
Fix tests.
1009
                    try:
1010
                        target_path = self.target.id2path(file_id)
1011
                    except errors.NoSuchId:
1012
                        target_path = None
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
1013
                        target_entry = None
1014
                    else:
7143.15.2 by Jelmer Vernooij
Run autopep8.
1015
                        target_entry = self._get_entry(
1016
                            self.target, target_path)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
1017
                    result, changes = self._changes_from_entries(
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
1018
                        source_entry, target_entry, source_path, target_path)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
1019
                else:
1020
                    changes = True
4570.2.5 by Robert Collins
Review feedback, including finding a bug with changes at the root.
1021
                # Get this parents parent to examine.
1022
                new_parent_id = result[4][1]
1023
                precise_file_ids.add(new_parent_id)
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
1024
                if changes:
1025
                    if (result[6][0] == 'directory' and
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
1026
                            result[6][1] != 'directory'):
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
1027
                        # This stopped being a directory, the old children have
1028
                        # to be included.
6885.6.5 by Jelmer Vernooij
Avoid more uses of specific_file_ids.
1029
                        if source_entry is None:
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
1030
                            # Reusing a discarded change.
7143.15.2 by Jelmer Vernooij
Run autopep8.
1031
                            source_entry = self._get_entry(
1032
                                self.source, result[1][0])
6471.1.7 by Jelmer Vernooij
merge bzr.dev.
1033
                        precise_file_ids.update(
7143.15.2 by Jelmer Vernooij
Run autopep8.
1034
                            child.file_id
1035
                            for child in self.source.iter_child_entries(result[1][0]))
4570.2.3 by Robert Collins
Change the way iter_changes treats specific files to prevent InconsistentDeltas.
1036
                    changed_file_ids.add(result[0])
1037
                    yield result
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1038
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
1039
    def file_content_matches(
6883.1.3 by Jelmer Vernooij
Add test, make file_id optional.
1040
            self, source_path, target_path,
6883.1.2 by Jelmer Vernooij
Fix order.
1041
            source_stat=None, target_stat=None):
5906.1.8 by Jelmer Vernooij
Tests.
1042
        """Check if two files are the same in the source and target trees.
1043
1044
        This only checks that the contents of the files are the same,
1045
        it does not touch anything else.
1046
6883.7.1 by Jelmer Vernooij
Swap order of arguments to Tree.file_content_matches.
1047
        :param source_path: Path of the file in the source tree
1048
        :param target_path: Path of the file in the target tree
6883.1.3 by Jelmer Vernooij
Add test, make file_id optional.
1049
        :param source_file_id: Optional file id of the file in the source tree
1050
        :param target_file_id: Optional file id of the file in the target tree
5906.1.8 by Jelmer Vernooij
Tests.
1051
        :param source_stat: Optional stat value of the file in the source tree
1052
        :param target_stat: Optional stat value of the file in the target tree
1053
        :return: Boolean indicating whether the files have the same contents
1054
        """
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
1055
        with self.lock_read():
1056
            source_verifier_kind, source_verifier_data = (
7143.15.15 by Jelmer Vernooij
Merge trunk.
1057
                self.source.get_file_verifier(source_path, source_stat))
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
1058
            target_verifier_kind, target_verifier_data = (
1059
                self.target.get_file_verifier(
7141.7.1 by Jelmer Vernooij
Get rid of file_ids in most of Tree.
1060
                    target_path, target_stat))
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
1061
            if source_verifier_kind == target_verifier_kind:
1062
                return (source_verifier_data == target_verifier_data)
1063
            # Fall back to SHA1 for now
1064
            if source_verifier_kind != "SHA1":
1065
                source_sha1 = self.source.get_file_sha1(
7143.15.2 by Jelmer Vernooij
Run autopep8.
1066
                    source_path, source_file_id, source_stat)
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
1067
            else:
1068
                source_sha1 = source_verifier_data
1069
            if target_verifier_kind != "SHA1":
1070
                target_sha1 = self.target.get_file_sha1(
7143.15.2 by Jelmer Vernooij
Run autopep8.
1071
                    target_path, target_file_id, target_stat)
6754.8.16 by Jelmer Vernooij
Get rid of all uses of needs_read_lock
1072
            else:
1073
                target_sha1 = target_verifier_data
1074
            return (source_sha1 == target_sha1)
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1075
7143.15.2 by Jelmer Vernooij
Run autopep8.
1076
5837.1.2 by Jelmer Vernooij
Register defaults as first optimiser for existing Inter objects.
1077
InterTree.register_optimiser(InterTree)
1078
1079
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1080
class MultiWalker(object):
1081
    """Walk multiple trees simultaneously, getting combined results."""
1082
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1083
    # Note: This could be written to not assume you can do out-of-order
1084
    #       lookups. Instead any nodes that don't match in all trees could be
1085
    #       marked as 'deferred', and then returned in the final cleanup loop.
1086
    #       For now, I think it is "nicer" to return things as close to the
1087
    #       "master_tree" order as we can.
1088
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1089
    def __init__(self, master_tree, other_trees):
1090
        """Create a new MultiWalker.
1091
1092
        All trees being walked must implement "iter_entries_by_dir()", such
1093
        that they yield (path, object) tuples, where that object will have a
1094
        '.file_id' member, that can be used to check equality.
1095
3514.3.11 by John Arbash Meinel
Cleanups suggested by Ian
1096
        :param master_tree: All trees will be 'slaved' to the master_tree such
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1097
            that nodes in master_tree will be used as 'first-pass' sync points.
1098
            Any nodes that aren't in master_tree will be merged in a second
1099
            pass.
1100
        :param other_trees: A list of other trees to walk simultaneously.
1101
        """
1102
        self._master_tree = master_tree
1103
        self._other_trees = other_trees
1104
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1105
        # Keep track of any nodes that were properly processed just out of
1106
        # order, that way we don't return them at the end, we don't have to
1107
        # track *all* processed file_ids, just the out-of-order ones
1108
        self._out_of_order_processed = set()
1109
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1110
    @staticmethod
1111
    def _step_one(iterator):
1112
        """Step an iter_entries_by_dir iterator.
1113
1114
        :return: (has_more, path, ie)
1115
            If has_more is False, path and ie will be None.
1116
        """
1117
        try:
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
1118
            path, ie = next(iterator)
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1119
        except StopIteration:
1120
            return False, None, None
1121
        else:
1122
            return True, path, ie
1123
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1124
    @staticmethod
7045.4.26 by Jelmer Vernooij
Fix some tree tests.
1125
    def _lt_path_by_dirblock(path1, path2):
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1126
        """Compare two paths based on what directory they are in.
1127
1128
        This generates a sort order, such that all children of a directory are
1129
        sorted together, and grandchildren are in the same order as the
1130
        children appear. But all grandchildren come after all children.
1131
1132
        :param path1: first path
1133
        :param path2: the second path
1134
        :return: negative number if ``path1`` comes first,
1135
            0 if paths are equal
1136
            and a positive number if ``path2`` sorts first
1137
        """
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1138
        # Shortcut this special case
1139
        if path1 == path2:
7045.4.26 by Jelmer Vernooij
Fix some tree tests.
1140
            return False
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1141
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1142
        # Unicode objects. Consider using encode_utf8() and then using the
1143
        # optimized versions, or maybe writing optimized unicode versions.
6973.6.2 by Jelmer Vernooij
Fix more tests.
1144
        if not isinstance(path1, text_type):
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1145
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1146
                            % (type(path1), path1))
6973.6.2 by Jelmer Vernooij
Fix more tests.
1147
        if not isinstance(path2, text_type):
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1148
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1149
                            % (type(path2), path2))
7045.4.26 by Jelmer Vernooij
Fix some tree tests.
1150
        return (MultiWalker._path_to_key(path1) <
1151
                MultiWalker._path_to_key(path2))
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1152
1153
    @staticmethod
3514.3.13 by John Arbash Meinel
One code path was using a tuple, another a plain path
1154
    def _path_to_key(path):
3514.3.11 by John Arbash Meinel
Cleanups suggested by Ian
1155
        dirname, basename = osutils.split(path)
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1156
        return (dirname.split(u'/'), basename)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1157
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1158
    def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
1159
        """Lookup an inventory entry by file_id.
1160
1161
        This is called when an entry is missing in the normal order.
1162
        Generally this is because a file was either renamed, or it was
1163
        deleted/added. If the entry was found in the inventory and not in
1164
        extra_entries, it will be added to self._out_of_order_processed
1165
1166
        :param extra_entries: A dictionary of {file_id: (path, ie)}.  This
1167
            should be filled with entries that were found before they were
1168
            used. If file_id is present, it will be removed from the
1169
            dictionary.
1170
        :param other_tree: The Tree to search, in case we didn't find the entry
1171
            yet.
1172
        :param file_id: The file_id to look for
1173
        :return: (path, ie) if found or (None, None) if not present.
1174
        """
1175
        if file_id in extra_entries:
1176
            return extra_entries.pop(file_id)
1177
        # TODO: Is id2path better as the first call, or is
1178
        #       inventory[file_id] better as a first check?
1179
        try:
1180
            cur_path = other_tree.id2path(file_id)
1181
        except errors.NoSuchId:
1182
            cur_path = None
1183
        if cur_path is None:
1184
            return (None, None)
1185
        else:
1186
            self._out_of_order_processed.add(file_id)
6915.4.2 by Jelmer Vernooij
Remove __getitem__ and __iter__ from Inventory.
1187
            cur_ie = other_tree.root_inventory.get_entry(file_id)
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1188
            return (cur_path, cur_ie)
1189
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1190
    def iter_all(self):
1191
        """Match up the values in the different trees."""
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1192
        for result in self._walk_master_tree():
1193
            yield result
1194
        self._finish_others()
1195
        for result in self._walk_others():
1196
            yield result
1197
1198
    def _walk_master_tree(self):
1199
        """First pass, walk all trees in lock-step.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1200
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1201
        When we are done, all nodes in the master_tree will have been
1202
        processed. _other_walkers, _other_entries, and _others_extra will be
1203
        set on 'self' for future processing.
1204
        """
1205
        # This iterator has the most "inlining" done, because it tends to touch
1206
        # every file in the tree, while the others only hit nodes that don't
1207
        # match.
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1208
        master_iterator = self._master_tree.iter_entries_by_dir()
1209
1210
        other_walkers = [other.iter_entries_by_dir()
1211
                         for other in self._other_trees]
1212
        other_entries = [self._step_one(walker) for walker in other_walkers]
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1213
        # Track extra nodes in the other trees
6651.2.2 by Martin
Apply 2to3 xrange fix and fix up with sixish range
1214
        others_extra = [{} for _ in range(len(self._other_trees))]
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1215
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1216
        master_has_more = True
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1217
        step_one = self._step_one
1218
        lookup_by_file_id = self._lookup_by_file_id
1219
        out_of_order_processed = self._out_of_order_processed
1220
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1221
        while master_has_more:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1222
            (master_has_more, path, master_ie) = step_one(master_iterator)
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1223
            if not master_has_more:
1224
                break
1225
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1226
            file_id = master_ie.file_id
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1227
            other_values = []
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1228
            other_values_append = other_values.append
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1229
            next_other_entries = []
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1230
            next_other_entries_append = next_other_entries.append
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1231
            for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1232
                if not other_has_more:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1233
                    other_values_append(lookup_by_file_id(
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1234
                        others_extra[idx], self._other_trees[idx], file_id))
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1235
                    next_other_entries_append((False, None, None))
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1236
                elif file_id == other_ie.file_id:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1237
                    # This is the critical code path, as most of the entries
1238
                    # should match between most trees.
1239
                    other_values_append((other_path, other_ie))
1240
                    next_other_entries_append(step_one(other_walkers[idx]))
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1241
                else:
1242
                    # This walker did not match, step it until it either
1243
                    # matches, or we know we are past the current walker.
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1244
                    other_walker = other_walkers[idx]
1245
                    other_extra = others_extra[idx]
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1246
                    while (other_has_more and
7045.4.26 by Jelmer Vernooij
Fix some tree tests.
1247
                           self._lt_path_by_dirblock(other_path, path)):
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1248
                        other_file_id = other_ie.file_id
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1249
                        if other_file_id not in out_of_order_processed:
1250
                            other_extra[other_file_id] = (other_path, other_ie)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1251
                        other_has_more, other_path, other_ie = \
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1252
                            step_one(other_walker)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1253
                    if other_has_more and other_ie.file_id == file_id:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1254
                        # We ended up walking to this point, match and step
1255
                        # again
1256
                        other_values_append((other_path, other_ie))
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1257
                        other_has_more, other_path, other_ie = \
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1258
                            step_one(other_walker)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1259
                    else:
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1260
                        # This record isn't in the normal order, see if it
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1261
                        # exists at all.
1262
                        other_values_append(lookup_by_file_id(
1263
                            other_extra, self._other_trees[idx], file_id))
1264
                    next_other_entries_append((other_has_more, other_path,
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1265
                                               other_ie))
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1266
            other_entries = next_other_entries
1267
1268
            # We've matched all the walkers, yield this datapoint
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1269
            yield path, file_id, master_ie, other_values
1270
        self._other_walkers = other_walkers
1271
        self._other_entries = other_entries
1272
        self._others_extra = others_extra
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1273
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1274
    def _finish_others(self):
1275
        """Finish walking the other iterators, so we get all entries."""
1276
        for idx, info in enumerate(self._other_entries):
1277
            other_extra = self._others_extra[idx]
1278
            (other_has_more, other_path, other_ie) = info
3514.3.4 by John Arbash Meinel
Handle more cases when the other tree has extra nodes.
1279
            while other_has_more:
1280
                other_file_id = other_ie.file_id
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1281
                if other_file_id not in self._out_of_order_processed:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1282
                    other_extra[other_file_id] = (other_path, other_ie)
3514.3.4 by John Arbash Meinel
Handle more cases when the other tree has extra nodes.
1283
                other_has_more, other_path, other_ie = \
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1284
                    self._step_one(self._other_walkers[idx])
1285
        del self._other_entries
1286
1287
    def _walk_others(self):
1288
        """Finish up by walking all the 'deferred' nodes."""
1289
        # TODO: One alternative would be to grab all possible unprocessed
1290
        #       file_ids, and then sort by path, and then yield them. That
1291
        #       might ensure better ordering, in case a caller strictly
1292
        #       requires parents before children.
1293
        for idx, other_extra in enumerate(self._others_extra):
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1294
            others = sorted(viewvalues(other_extra),
3514.3.13 by John Arbash Meinel
One code path was using a tuple, another a plain path
1295
                            key=lambda x: self._path_to_key(x[0]))
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1296
            for other_path, other_ie in others:
1297
                file_id = other_ie.file_id
3514.3.7 by John Arbash Meinel
comment
1298
                # We don't need to check out_of_order_processed here, because
1299
                # the lookup_by_file_id will be removing anything processed
1300
                # from the extras cache
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1301
                other_extra.pop(file_id)
6651.2.2 by Martin
Apply 2to3 xrange fix and fix up with sixish range
1302
                other_values = [(None, None)] * idx
3514.3.5 by John Arbash Meinel
Handle some edge cases when we have multiple other trees.
1303
                other_values.append((other_path, other_ie))
7143.15.2 by Jelmer Vernooij
Run autopep8.
1304
                for alt_idx, alt_extra in enumerate(self._others_extra[idx + 1:]):
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1305
                    alt_idx = alt_idx + idx + 1
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1306
                    alt_extra = self._others_extra[alt_idx]
1307
                    alt_tree = self._other_trees[alt_idx]
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1308
                    other_values.append(self._lookup_by_file_id(
7143.15.2 by Jelmer Vernooij
Run autopep8.
1309
                        alt_extra, alt_tree, file_id))
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1310
                yield other_path, file_id, None, other_values
6883.5.2 by Jelmer Vernooij
Add find_previous_paths call.
1311
1312
1313
def find_previous_paths(from_tree, to_tree, paths):
1314
    """Find previous tree paths.
1315
1316
    :param from_tree: From tree
1317
    :param to_tree: To tree
1318
    :param paths: Iterable over paths to search for
1319
    :return: Dictionary mapping from from_tree paths to paths in to_tree, or
1320
        None if there is no equivalent path.
1321
    """
1322
    ret = {}
1323
    for path in paths:
6883.5.3 by Jelmer Vernooij
Add find_previous_path.
1324
        ret[path] = find_previous_path(from_tree, to_tree, path)
6883.5.2 by Jelmer Vernooij
Add find_previous_paths call.
1325
    return ret
6883.5.3 by Jelmer Vernooij
Add find_previous_path.
1326
1327
6883.5.11 by Jelmer Vernooij
Fix tests.
1328
def find_previous_path(from_tree, to_tree, path, file_id=None):
6883.5.3 by Jelmer Vernooij
Add find_previous_path.
1329
    """Find previous tree path.
1330
1331
    :param from_tree: From tree
1332
    :param to_tree: To tree
1333
    :param path: Path to search for
1334
    :return: path in to_tree, or None if there is no equivalent path.
1335
    """
6883.5.11 by Jelmer Vernooij
Fix tests.
1336
    if file_id is None:
1337
        file_id = from_tree.path2id(path)
6883.5.3 by Jelmer Vernooij
Add find_previous_path.
1338
    if file_id is None:
1339
        raise errors.NoSuchFile(path)
1340
    try:
1341
        return to_tree.id2path(file_id)
1342
    except errors.NoSuchId:
1343
        return None
7104.3.3 by Jelmer Vernooij
Move get_canonical_paths to WorkingTree.
1344
1345
7104.3.4 by Jelmer Vernooij
Fix tests.
1346
def get_canonical_path(tree, path, normalize):
7104.3.3 by Jelmer Vernooij
Move get_canonical_paths to WorkingTree.
1347
    """Find the canonical path of an item, ignoring case.
1348
1349
    :param tree: Tree to traverse
1350
    :param path: Case-insensitive path to look up
7104.3.4 by Jelmer Vernooij
Fix tests.
1351
    :param normalize: Function to normalize a filename for comparison
7104.3.3 by Jelmer Vernooij
Move get_canonical_paths to WorkingTree.
1352
    :return: The canonical path
1353
    """
1354
    # go walkin...
7131.4.1 by Jelmer Vernooij
Fix get_canonical_path and add some basic tests.
1355
    cur_id = tree.get_root_id()
7104.3.3 by Jelmer Vernooij
Move get_canonical_paths to WorkingTree.
1356
    cur_path = ''
1357
    bit_iter = iter(path.split("/"))
1358
    for elt in bit_iter:
7104.3.4 by Jelmer Vernooij
Fix tests.
1359
        lelt = normalize(elt)
7104.3.3 by Jelmer Vernooij
Move get_canonical_paths to WorkingTree.
1360
        new_path = None
1361
        try:
7131.4.1 by Jelmer Vernooij
Fix get_canonical_path and add some basic tests.
1362
            for child in tree.iter_child_entries(cur_path, cur_id):
7104.3.3 by Jelmer Vernooij
Move get_canonical_paths to WorkingTree.
1363
                try:
1364
                    if child.name == elt:
1365
                        # if we found an exact match, we can stop now; if
1366
                        # we found an approximate match we need to keep
1367
                        # searching because there might be an exact match
1368
                        # later.
1369
                        cur_id = child.file_id
1370
                        new_path = osutils.pathjoin(cur_path, child.name)
1371
                        break
7104.3.4 by Jelmer Vernooij
Fix tests.
1372
                    elif normalize(child.name) == lelt:
7104.3.3 by Jelmer Vernooij
Move get_canonical_paths to WorkingTree.
1373
                        cur_id = child.file_id
1374
                        new_path = osutils.pathjoin(cur_path, child.name)
1375
                except errors.NoSuchId:
1376
                    # before a change is committed we can see this error...
1377
                    continue
1378
        except errors.NotADirectory:
1379
            pass
1380
        if new_path:
1381
            cur_path = new_path
1382
        else:
1383
            # got to the end of this directory and no entries matched.
1384
            # Return what matched so far, plus the rest as specified.
1385
            cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
1386
            break
1387
    return cur_path