17
17
"""Tree classes, representing directory at point in time.
21
from collections import deque
20
from __future__ import absolute_import
23
from collections.abc import deque
24
except ImportError: # python < 3.7
25
from collections import deque
27
from .lazy_import import lazy_import
28
lazy_import(globals(), """
25
31
conflicts as _mod_conflicts,
30
35
revision as _mod_revision,
33
from bzrlib.decorators import needs_read_lock
34
from bzrlib.errors import BzrError, NoSuchId
35
from bzrlib import errors
36
from bzrlib.inventory import InventoryFile
37
from bzrlib.inter import InterObject
38
from bzrlib.osutils import fingerprint_file
39
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
40
from bzrlib.trace import note
39
from breezy.i18n import gettext
47
from .inter import InterObject
54
class FileTimestampUnavailable(errors.BzrError):
56
_fmt = "The filestamp for %(path)s is not available."
60
def __init__(self, path):
64
class TreeEntry(object):
65
"""An entry that implements the minimum interface used by commands.
68
def __eq__(self, other):
69
# yes, this is ugly, TODO: best practice __eq__ style.
70
return (isinstance(other, TreeEntry)
71
and other.__class__ == self.__class__)
75
def kind_character(self):
79
class TreeDirectory(TreeEntry):
80
"""See TreeEntry. This is a directory in a working tree."""
84
def kind_character(self):
88
class TreeFile(TreeEntry):
89
"""See TreeEntry. This is a regular file in a working tree."""
93
def kind_character(self):
97
class TreeLink(TreeEntry):
98
"""See TreeEntry. This is a symlink in a working tree."""
102
def kind_character(self):
106
class TreeReference(TreeEntry):
107
"""See TreeEntry. This is a reference to a nested tree in a working tree."""
109
kind = 'tree-reference'
111
def kind_character(self):
43
115
class Tree(object):
50
122
* `RevisionTree` is a tree as recorded at some point in the past.
52
Trees contain an `Inventory` object, and also know how to retrieve
53
file texts mentioned in the inventory, either from a working
54
directory or from a store.
56
It is possible for trees to contain files that are not described
57
in their inventory or vice versa; for this use `filenames()`.
59
124
Trees can be compared, etc, regardless of whether they are working
60
125
trees or versioned trees.
128
def supports_rename_tracking(self):
129
"""Whether this tree supports rename tracking.
131
This defaults to True, but some implementations may want to override
136
def has_versioned_directories(self):
137
"""Whether this tree can contain explicitly versioned directories.
139
This defaults to True, but some implementations may want to override
63
144
def changes_from(self, other, want_unchanged=False, specific_files=None,
64
extra_trees=None, require_versioned=False, include_root=False,
65
want_unversioned=False):
145
extra_trees=None, require_versioned=False, include_root=False,
146
want_unversioned=False):
66
147
"""Return a TreeDelta of the changes from other to this tree.
68
149
:param other: A tree to compare with.
147
return iter(self.inventory)
149
218
def all_file_ids(self):
150
219
"""Iterate through all file ids, including ids for missing files."""
151
return set(self.inventory)
220
raise NotImplementedError(self.all_file_ids)
222
def all_versioned_paths(self):
223
"""Iterate through all paths, including paths for missing files."""
224
raise NotImplementedError(self.all_versioned_paths)
153
226
def id2path(self, file_id):
154
227
"""Return the path for a file id.
156
229
:raises NoSuchId:
158
return self.inventory.id2path(file_id)
160
def is_control_filename(self, filename):
161
"""True if filename is the name of a control file in this tree.
163
:param filename: A filename within the tree. This is a relative path
164
from the root of this tree.
166
This is true IF and ONLY IF the filename is part of the meta data
167
that bzr controls in this tree. I.E. a random .bzr directory placed
168
on disk will not be a control file for this tree.
170
return self.bzrdir.is_control_filename(filename)
173
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
231
raise NotImplementedError(self.id2path)
233
def iter_entries_by_dir(self, specific_files=None):
174
234
"""Walk the tree in 'by_dir' order.
176
236
This will yield each entry in the tree as a (path, entry) tuple.
194
254
The yield order (ignoring root) would be::
195
256
a, f, a/b, a/d, a/b/c, a/d/e, f/g
197
:param yield_parents: If True, yield the parents from the root leading
198
down to specific_file_ids that have been requested. This has no
199
impact if specific_file_ids is None.
201
return self.inventory.iter_entries_by_dir(
202
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
258
raise NotImplementedError(self.iter_entries_by_dir)
260
def iter_child_entries(self, path):
261
"""Iterate over the children of a directory or tree reference.
263
:param path: Path of the directory
264
:raise NoSuchFile: When the path does not exist
265
:return: Iterator over entries in the directory
267
raise NotImplementedError(self.iter_child_entries)
269
def list_files(self, include_root=False, from_dir=None, recursive=True):
270
"""List all files in this tree.
272
:param include_root: Whether to include the entry for the tree root
273
:param from_dir: Directory under which to list files
274
:param recursive: Whether to list files recursively
275
:return: iterator over tuples of
276
(path, versioned, kind, inventory entry)
278
raise NotImplementedError(self.list_files)
204
280
def iter_references(self):
205
281
if self.supports_tree_reference():
254
330
raise NotImplementedError(self._comparison_data)
256
def _file_size(self, entry, stat_value):
257
raise NotImplementedError(self._file_size)
259
def _get_inventory(self):
260
return self._inventory
262
def get_file(self, file_id, path=None):
263
"""Return a file object for the file file_id in the tree.
265
If both file_id and path are defined, it is implementation defined as
266
to which one is used.
332
def get_file(self, path):
333
"""Return a file object for the file path in the tree.
268
335
raise NotImplementedError(self.get_file)
270
def get_file_with_stat(self, file_id, path=None):
271
"""Get a file handle and stat object for file_id.
337
def get_file_with_stat(self, path):
338
"""Get a file handle and stat object for path.
273
340
The default implementation returns (self.get_file, None) for backwards
276
:param file_id: The file id to read.
277
:param path: The path of the file, if it is known.
343
:param path: The path of the file.
278
344
:return: A tuple (file_handle, stat_value_or_None). If the tree has
279
345
no stat facility, or need for a stat cache feedback during commit,
280
346
it may return None for the second element of the tuple.
282
return (self.get_file(file_id, path), None)
348
return (self.get_file(path), None)
284
def get_file_text(self, file_id, path=None):
350
def get_file_text(self, path):
285
351
"""Return the byte content of a file.
287
:param file_id: The file_id of the file.
288
353
:param path: The path of the file.
289
If both file_id and path are supplied, an implementation may use
355
:returns: A single byte string for the whole file.
292
my_file = self.get_file(file_id, path)
357
with self.get_file(path) as my_file:
294
358
return my_file.read()
298
def get_file_lines(self, file_id, path=None):
360
def get_file_lines(self, path):
299
361
"""Return the content of a file, as lines.
301
:param file_id: The file_id of the file.
302
363
:param path: The path of the file.
303
If both file_id and path are supplied, an implementation may use
306
return osutils.split_lines(self.get_file_text(file_id, path))
308
def get_file_mtime(self, file_id, path=None):
365
return osutils.split_lines(self.get_file_text(path))
367
def get_file_verifier(self, path, stat_value=None):
368
"""Return a verifier for a file.
370
The default implementation returns a sha1.
372
:param path: The path that this file can be found at.
373
These must point to the same object.
374
:param stat_value: Optional stat value for the object
375
:return: Tuple with verifier name and verifier data
377
return ("SHA1", self.get_file_sha1(path, stat_value=stat_value))
379
def get_file_sha1(self, path, stat_value=None):
380
"""Return the SHA1 file for a file.
382
:note: callers should use get_file_verifier instead
383
where possible, as the underlying repository implementation may
384
have quicker access to a non-sha1 verifier.
386
:param path: The path that this file can be found at.
387
:param stat_value: Optional stat value for the object
389
raise NotImplementedError(self.get_file_sha1)
391
def get_file_mtime(self, path):
309
392
"""Return the modification time for a file.
311
:param file_id: The handle for this file.
312
394
:param path: The path that this file can be found at.
313
These must point to the same object.
315
396
raise NotImplementedError(self.get_file_mtime)
317
def get_file_size(self, file_id):
398
def get_file_size(self, path):
318
399
"""Return the size of a file in bytes.
320
401
This applies only to regular files. If invoked on directories or
321
402
symlinks, it will return None.
322
:param file_id: The file-id of the file
324
404
raise NotImplementedError(self.get_file_size)
326
def get_file_by_path(self, path):
327
return self.get_file(self._inventory.path2id(path), path)
406
def is_executable(self, path):
407
"""Check if a file is executable.
409
:param path: The path that this file can be found at.
411
raise NotImplementedError(self.is_executable)
329
413
def iter_files_bytes(self, desired_files):
330
414
"""Iterate through file contents.
342
426
this implementation, it is a tuple containing a single bytestring with
343
427
the complete text of the file.
345
:param desired_files: a list of (file_id, identifier) pairs
429
:param desired_files: a list of (path, identifier) pairs
347
for file_id, identifier in desired_files:
431
for path, identifier in desired_files:
348
432
# We wrap the string in a tuple so that we can return an iterable
349
433
# of bytestrings. (Technically, a bytestring is also an iterable
350
434
# of bytestrings, but iterating through each character is not
352
cur_file = (self.get_file_text(file_id),)
436
cur_file = (self.get_file_text(path),)
353
437
yield identifier, cur_file
355
def get_symlink_target(self, file_id):
356
"""Get the target for a given file_id.
439
def get_symlink_target(self, path):
440
"""Get the target for a given path.
358
It is assumed that the caller already knows that file_id is referencing
442
It is assumed that the caller already knows that path is referencing
360
:param file_id: Handle for the symlink entry.
444
:param path: The path of the file.
361
445
:return: The path the symlink points to.
363
447
raise NotImplementedError(self.get_symlink_target)
365
def get_canonical_inventory_paths(self, paths):
366
"""Like get_canonical_inventory_path() but works on multiple items.
368
:param paths: A sequence of paths relative to the root of the tree.
369
:return: A list of paths, with each item the corresponding input path
370
adjusted to account for existing elements that match case
373
return list(self._yield_canonical_inventory_paths(paths))
375
def get_canonical_inventory_path(self, path):
376
"""Returns the first inventory item that case-insensitively matches path.
378
If a path matches exactly, it is returned. If no path matches exactly
379
but more than one path matches case-insensitively, it is implementation
380
defined which is returned.
382
If no path matches case-insensitively, the input path is returned, but
383
with as many path entries that do exist changed to their canonical
386
If you need to resolve many names from the same tree, you should
387
use get_canonical_inventory_paths() to avoid O(N) behaviour.
389
:param path: A paths relative to the root of the tree.
390
:return: The input path adjusted to account for existing elements
391
that match case insensitively.
393
return self._yield_canonical_inventory_paths([path]).next()
395
def _yield_canonical_inventory_paths(self, paths):
397
# First, if the path as specified exists exactly, just use it.
398
if self.path2id(path) is not None:
402
cur_id = self.get_root_id()
404
bit_iter = iter(path.split("/"))
408
for child in self.iter_children(cur_id):
410
# XXX: it seem like if the child is known to be in the
411
# tree, we shouldn't need to go from its id back to
412
# its path -- mbp 2010-02-11
414
# XXX: it seems like we could be more efficient
415
# by just directly looking up the original name and
416
# only then searching all children; also by not
417
# chopping paths so much. -- mbp 2010-02-11
418
child_base = os.path.basename(self.id2path(child))
419
if (child_base == elt):
420
# if we found an exact match, we can stop now; if
421
# we found an approximate match we need to keep
422
# searching because there might be an exact match
425
new_path = osutils.pathjoin(cur_path, child_base)
427
elif child_base.lower() == lelt:
429
new_path = osutils.pathjoin(cur_path, child_base)
431
# before a change is committed we can see this error...
436
# got to the end of this directory and no entries matched.
437
# Return what matched so far, plus the rest as specified.
438
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
443
449
def get_root_id(self):
444
450
"""Return the file_id for the root of this tree."""
445
451
raise NotImplementedError(self.get_root_id)
447
def annotate_iter(self, file_id,
453
def annotate_iter(self, path,
448
454
default_revision=_mod_revision.CURRENT_REVISION):
449
455
"""Return an iterator of revision_id, line tuples.
451
457
For working trees (and mutable trees in general), the special
452
458
revision_id 'current:' will be used for lines that are new in this
453
459
tree, e.g. uncommitted changes.
454
:param file_id: The file to produce an annotated version from
460
:param path: The file to produce an annotated version from
455
461
:param default_revision: For lines that don't match a basis, mark them
456
462
with this revision id. Not all implementations will make use of
459
465
raise NotImplementedError(self.annotate_iter)
461
def _get_plan_merge_data(self, file_id, other, base):
462
from bzrlib import versionedfile
463
vf = versionedfile._PlanMergeVersionedFile(file_id)
464
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
465
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
467
last_revision_base = None
469
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
470
return vf, last_revision_a, last_revision_b, last_revision_base
472
def plan_file_merge(self, file_id, other, base=None):
473
"""Generate a merge plan based on annotations.
475
If the file contains uncommitted changes in this tree, they will be
476
attributed to the 'current:' pseudo-revision. If the file contains
477
uncommitted changes in the other tree, they will be assigned to the
478
'other:' pseudo-revision.
480
data = self._get_plan_merge_data(file_id, other, base)
481
vf, last_revision_a, last_revision_b, last_revision_base = data
482
return vf.plan_merge(last_revision_a, last_revision_b,
485
def plan_file_lca_merge(self, file_id, other, base=None):
486
"""Generate a merge plan based lca-newness.
488
If the file contains uncommitted changes in this tree, they will be
489
attributed to the 'current:' pseudo-revision. If the file contains
490
uncommitted changes in the other tree, they will be assigned to the
491
'other:' pseudo-revision.
493
data = self._get_plan_merge_data(file_id, other, base)
494
vf, last_revision_a, last_revision_b, last_revision_base = data
495
return vf.plan_lca_merge(last_revision_a, last_revision_b,
498
467
def _iter_parent_trees(self):
499
468
"""Iterate through parent trees, defaulting to Tree.revision_tree."""
500
469
for revision_id in self.get_parent_ids():
503
472
except errors.NoSuchRevisionInTree:
504
473
yield self.repository.revision_tree(revision_id)
507
def _file_revision(revision_tree, file_id):
508
"""Determine the revision associated with a file in a given tree."""
509
revision_tree.lock_read()
511
return revision_tree.inventory[file_id].revision
513
revision_tree.unlock()
515
def _get_file_revision(self, file_id, vf, tree_revision):
516
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
518
if getattr(self, '_repository', None) is None:
519
last_revision = tree_revision
520
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
521
self._iter_parent_trees()]
522
vf.add_lines((file_id, last_revision), parent_keys,
523
self.get_file(file_id).readlines())
524
repo = self.branch.repository
527
last_revision = self._file_revision(self, file_id)
528
base_vf = self._repository.texts
529
if base_vf not in vf.fallback_versionedfiles:
530
vf.fallback_versionedfiles.append(base_vf)
533
inventory = property(_get_inventory,
534
doc="Inventory of this Tree")
536
def _check_retrieved(self, ie, f):
539
fp = fingerprint_file(f)
542
if ie.text_size is not None:
543
if ie.text_size != fp['size']:
544
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
545
["inventory expects %d bytes" % ie.text_size,
546
"file is actually %d bytes" % fp['size'],
547
"store is probably damaged/corrupt"])
549
if ie.text_sha1 != fp['sha1']:
550
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
551
["inventory expects %s" % ie.text_sha1,
552
"file is actually %s" % fp['sha1'],
553
"store is probably damaged/corrupt"])
556
475
def path2id(self, path):
557
476
"""Return the id for path in this tree."""
558
return self._inventory.path2id(path)
560
def paths2ids(self, paths, trees=[], require_versioned=True):
561
"""Return all the ids that can be reached by walking from paths.
563
Each path is looked up in this tree and any extras provided in
564
trees, and this is repeated recursively: the children in an extra tree
565
of a directory that has been renamed under a provided path in this tree
566
are all returned, even if none exist under a provided path in this
567
tree, and vice versa.
569
:param paths: An iterable of paths to start converting to ids from.
570
Alternatively, if paths is None, no ids should be calculated and None
571
will be returned. This is offered to make calling the api unconditional
572
for code that *might* take a list of files.
573
:param trees: Additional trees to consider.
574
:param require_versioned: If False, do not raise NotVersionedError if
575
an element of paths is not versioned in this tree and all of trees.
577
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
579
def iter_children(self, file_id):
580
entry = self.iter_entries_by_dir([file_id]).next()[1]
581
for child in getattr(entry, 'children', {}).itervalues():
477
raise NotImplementedError(self.path2id)
479
def is_versioned(self, path):
480
"""Check whether path is versioned.
482
:param path: Path to check
485
return self.path2id(path) is not None
487
def find_related_paths_across_trees(self, paths, trees=[],
488
require_versioned=True):
489
"""Find related paths in tree corresponding to specified filenames in any
492
All matches in all trees will be used, and all children of matched
493
directories will be used.
495
:param paths: The filenames to find related paths for (if None, returns
497
:param trees: The trees to find file_ids within
498
:param require_versioned: if true, all specified filenames must occur in
500
:return: a set of paths for the specified filenames and their children
503
raise NotImplementedError(self.find_related_paths_across_trees)
584
505
def lock_read(self):
585
506
"""Lock this tree for multiple read only operations.
587
:return: A bzrlib.lock.LogicalLockResult.
508
:return: A breezy.lock.LogicalLockResult.
510
return lock.LogicalLockResult(self.unlock)
591
512
def revision_tree(self, revision_id):
592
513
"""Obtain a revision tree for the revision revision_id.
724
642
searcher = default_searcher
728
######################################################################
731
# TODO: Merge these two functions into a single one that can operate
732
# on either a whole tree or a set of files.
734
# TODO: Return the diff in order by filename, not by category or in
735
# random order. Can probably be done by lock-stepping through the
736
# filenames from both trees.
739
def file_status(filename, old_tree, new_tree):
740
"""Return single-letter status, old and new names for a file.
742
The complexity here is in deciding how to represent renames;
743
many complex cases are possible.
745
old_inv = old_tree.inventory
746
new_inv = new_tree.inventory
747
new_id = new_inv.path2id(filename)
748
old_id = old_inv.path2id(filename)
750
if not new_id and not old_id:
751
# easy: doesn't exist in either; not versioned at all
752
if new_tree.is_ignored(filename):
753
return 'I', None, None
755
return '?', None, None
757
# There is now a file of this name, great.
760
# There is no longer a file of this name, but we can describe
761
# what happened to the file that used to have
762
# this name. There are two possibilities: either it was
763
# deleted entirely, or renamed.
764
if new_inv.has_id(old_id):
765
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
767
return 'D', old_inv.id2path(old_id), None
769
# if the file_id is new in this revision, it is added
770
if new_id and not old_inv.has_id(new_id):
773
# if there used to be a file of this name, but that ID has now
774
# disappeared, it is deleted
775
if old_id and not new_inv.has_id(old_id):
781
@deprecated_function(deprecated_in((1, 9, 0)))
782
def find_renames(old_inv, new_inv):
783
for file_id in old_inv:
784
if file_id not in new_inv:
786
old_name = old_inv.id2path(file_id)
787
new_name = new_inv.id2path(file_id)
788
if old_name != new_name:
789
yield (old_name, new_name)
792
def find_ids_across_trees(filenames, trees, require_versioned=True):
793
"""Find the ids corresponding to specified filenames.
795
All matches in all trees will be used, and all children of matched
796
directories will be used.
798
:param filenames: The filenames to find file_ids for (if None, returns
800
:param trees: The trees to find file_ids within
801
:param require_versioned: if true, all specified filenames must occur in
803
:return: a set of file ids for the specified filenames and their children.
807
specified_path_ids = _find_ids_across_trees(filenames, trees,
809
return _find_children_across_trees(specified_path_ids, trees)
812
def _find_ids_across_trees(filenames, trees, require_versioned):
813
"""Find the ids corresponding to specified filenames.
815
All matches in all trees will be used, but subdirectories are not scanned.
817
:param filenames: The filenames to find file_ids for
818
:param trees: The trees to find file_ids within
819
:param require_versioned: if true, all specified filenames must occur in
821
:return: a set of file ids for the specified filenames
824
interesting_ids = set()
825
for tree_path in filenames:
828
file_id = tree.path2id(tree_path)
829
if file_id is not None:
830
interesting_ids.add(file_id)
833
not_versioned.append(tree_path)
834
if len(not_versioned) > 0 and require_versioned:
835
raise errors.PathsNotVersionedError(not_versioned)
836
return interesting_ids
839
def _find_children_across_trees(specified_ids, trees):
840
"""Return a set including specified ids and their children.
842
All matches in all trees will be used.
844
:param trees: The trees to find file_ids within
845
:return: a set containing all specified ids and their children
847
interesting_ids = set(specified_ids)
848
pending = interesting_ids
849
# now handle children of interesting ids
850
# we loop so that we handle all children of each id in both trees
851
while len(pending) > 0:
853
for file_id in pending:
855
if not tree.has_or_had_id(file_id):
857
for child_id in tree.iter_children(file_id):
858
if child_id not in interesting_ids:
859
new_pending.add(child_id)
860
interesting_ids.update(new_pending)
861
pending = new_pending
862
return interesting_ids
645
def archive(self, format, name, root='', subdir=None,
647
"""Create an archive of this tree.
649
:param format: Format name (e.g. 'tar')
650
:param name: target file name
651
:param root: Root directory name (or None)
652
:param subdir: Subdirectory to export (or None)
653
:return: Iterator over archive chunks
655
from .archive import create_archive
656
with self.lock_read():
657
return create_archive(format, self, name, root,
658
subdir, force_mtime=force_mtime)
661
def versionable_kind(cls, kind):
662
"""Check if this tree support versioning a specific file kind."""
663
return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
865
666
class InterTree(InterObject):
934
735
if source_kind != target_kind:
935
736
changed_content = True
936
737
elif source_kind == 'file':
937
if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
938
self.target.get_file_sha1(file_id, target_path, target_stat)):
738
if not self.file_content_matches(
739
source_path, target_path,
740
source_stat, target_stat):
939
741
changed_content = True
940
742
elif source_kind == 'symlink':
941
if (self.source.get_symlink_target(file_id) !=
942
self.target.get_symlink_target(file_id)):
943
changed_content = True
944
# XXX: Yes, the indentation below is wrong. But fixing it broke
945
# test_merge.TestMergerEntriesLCAOnDisk.
946
# test_nested_tree_subtree_renamed_and_modified. We'll wait for
947
# the fix from bzr.dev -- vila 2009026
948
elif source_kind == 'tree-reference':
949
if (self.source.get_reference_revision(file_id, source_path)
950
!= self.target.get_reference_revision(file_id, target_path)):
951
changed_content = True
743
if (self.source.get_symlink_target(source_path) !=
744
self.target.get_symlink_target(target_path)):
745
changed_content = True
746
elif source_kind == 'tree-reference':
747
if (self.source.get_reference_revision(source_path)
748
!= self.target.get_reference_revision(target_path)):
749
changed_content = True
952
750
parent = (source_parent, target_parent)
953
751
name = (source_name, target_name)
954
752
executable = (source_executable, target_executable)
955
if (changed_content is not False or versioned[0] != versioned[1]
956
or parent[0] != parent[1] or name[0] != name[1] or
957
executable[0] != executable[1]):
753
if (changed_content is not False or versioned[0] != versioned[1] or
754
parent[0] != parent[1] or name[0] != name[1] or
755
executable[0] != executable[1]):
961
759
return (file_id, (source_path, target_path), changed_content,
962
760
versioned, parent, name, kind, executable), changes
965
762
def compare(self, want_unchanged=False, specific_files=None,
966
extra_trees=None, require_versioned=False, include_root=False,
967
want_unversioned=False):
763
extra_trees=None, require_versioned=False, include_root=False,
764
want_unversioned=False):
968
765
"""Return the changes from source to target.
970
767
:return: A TreeDelta.
984
781
trees = (self.source,)
985
782
if extra_trees is not None:
986
783
trees = trees + tuple(extra_trees)
987
# target is usually the newer tree:
988
specific_file_ids = self.target.paths2ids(specific_files, trees,
989
require_versioned=require_versioned)
990
if specific_files and not specific_file_ids:
991
# All files are unversioned, so just return an empty delta
992
# _compare_trees would think we want a complete delta
993
result = delta.TreeDelta()
994
fake_entry = InventoryFile('unused', 'unused', 'unused')
995
result.unversioned = [(path, None,
996
self.target._comparison_data(fake_entry, path)[0]) for path in
999
return delta._compare_trees(self.source, self.target, want_unchanged,
1000
specific_files, include_root, extra_trees=extra_trees,
1001
require_versioned=require_versioned,
1002
want_unversioned=want_unversioned)
784
with self.lock_read():
785
return delta._compare_trees(self.source, self.target, want_unchanged,
786
specific_files, include_root, extra_trees=extra_trees,
787
require_versioned=require_versioned,
788
want_unversioned=want_unversioned)
1004
790
def iter_changes(self, include_unchanged=False,
1005
specific_files=None, pb=None, extra_trees=[],
1006
require_versioned=True, want_unversioned=False):
791
specific_files=None, pb=None, extra_trees=[],
792
require_versioned=True, want_unversioned=False):
1007
793
"""Generate an iterator of changes between trees.
1009
795
A tuple is returned:
1059
851
seen_dirs = set()
1060
852
if want_unversioned:
1061
853
all_unversioned = sorted([(p.split('/'), p) for p in
1062
self.target.extras()
1063
if specific_files is None or
1064
osutils.is_inside_any(specific_files, p)])
855
if specific_files is None or
856
osutils.is_inside_any(specific_files, p)])
1065
857
all_unversioned = deque(all_unversioned)
1067
859
all_unversioned = deque()
1069
861
from_entries_by_dir = list(self.source.iter_entries_by_dir(
1070
specific_file_ids=specific_file_ids))
862
specific_files=source_specific_files))
1071
863
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1072
864
to_entries_by_dir = list(self.target.iter_entries_by_dir(
1073
specific_file_ids=specific_file_ids))
865
specific_files=target_specific_files))
1074
866
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1076
868
# the unversioned path lookup only occurs on real trees - where there
1077
869
# can be extras. So the fake_entry is solely used to look up
1078
870
# executable it values when execute is not supported.
1079
fake_entry = InventoryFile('unused', 'unused', 'unused')
871
fake_entry = TreeFile()
1080
872
for target_path, target_entry in to_entries_by_dir:
1081
873
while (all_unversioned and
1082
all_unversioned[0][0] < target_path.split('/')):
874
all_unversioned[0][0] < target_path.split('/')):
1083
875
unversioned_path = all_unversioned.popleft()
1084
876
target_kind, target_executable, target_stat = \
1085
self.target._comparison_data(fake_entry, unversioned_path[1])
877
self.target._comparison_data(
878
fake_entry, unversioned_path[1])
1086
879
yield (None, (None, unversioned_path[1]), True, (False, False),
1088
(None, unversioned_path[0][-1]),
1089
(None, target_kind),
1090
(None, target_executable))
881
(None, unversioned_path[0][-1]),
883
(None, target_executable))
1091
884
source_path, source_entry = from_data.get(target_entry.file_id,
1093
886
result, changes = self._changes_from_entries(source_entry,
1094
target_entry, source_path=source_path, target_path=target_path)
887
target_entry, source_path=source_path, target_path=target_path)
1095
888
to_paths[result[0]] = result[1][1]
1096
889
entry_count += 1
1097
890
if result[3][0]:
1243
1037
precise_file_ids.add(new_parent_id)
1245
1039
if (result[6][0] == 'directory' and
1246
result[6][1] != 'directory'):
1040
result[6][1] != 'directory'):
1247
1041
# This stopped being a directory, the old children have
1248
1042
# to be included.
1249
if old_entry is None:
1043
if source_entry is None:
1250
1044
# Reusing a discarded change.
1251
old_entry = self._get_entry(self.source, file_id)
1252
for child in old_entry.children.values():
1253
precise_file_ids.add(child.file_id)
1045
source_entry = self._get_entry(
1046
self.source, result[1][0])
1047
precise_file_ids.update(
1049
for child in self.source.iter_child_entries(result[1][0]))
1254
1050
changed_file_ids.add(result[0])
1053
def file_content_matches(
1054
self, source_path, target_path,
1055
source_stat=None, target_stat=None):
1056
"""Check if two files are the same in the source and target trees.
1058
This only checks that the contents of the files are the same,
1059
it does not touch anything else.
1061
:param source_path: Path of the file in the source tree
1062
:param target_path: Path of the file in the target tree
1063
:param source_file_id: Optional file id of the file in the source tree
1064
:param target_file_id: Optional file id of the file in the target tree
1065
:param source_stat: Optional stat value of the file in the source tree
1066
:param target_stat: Optional stat value of the file in the target tree
1067
:return: Boolean indicating whether the files have the same contents
1069
with self.lock_read():
1070
source_verifier_kind, source_verifier_data = (
1071
self.source.get_file_verifier(source_path, source_stat))
1072
target_verifier_kind, target_verifier_data = (
1073
self.target.get_file_verifier(
1074
target_path, target_stat))
1075
if source_verifier_kind == target_verifier_kind:
1076
return (source_verifier_data == target_verifier_data)
1077
# Fall back to SHA1 for now
1078
if source_verifier_kind != "SHA1":
1079
source_sha1 = self.source.get_file_sha1(
1080
source_path, source_file_id, source_stat)
1082
source_sha1 = source_verifier_data
1083
if target_verifier_kind != "SHA1":
1084
target_sha1 = self.target.get_file_sha1(
1085
target_path, target_file_id, target_stat)
1087
target_sha1 = target_verifier_data
1088
return (source_sha1 == target_sha1)
1091
InterTree.register_optimiser(InterTree)
1258
1094
class MultiWalker(object):
1259
1095
"""Walk multiple trees simultaneously, getting combined results."""
1477
1313
# the lookup_by_file_id will be removing anything processed
1478
1314
# from the extras cache
1479
1315
other_extra.pop(file_id)
1480
other_values = [(None, None) for i in xrange(idx)]
1316
other_values = [(None, None)] * idx
1481
1317
other_values.append((other_path, other_ie))
1482
for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1318
for alt_idx, alt_extra in enumerate(self._others_extra[idx + 1:]):
1483
1319
alt_idx = alt_idx + idx + 1
1484
1320
alt_extra = self._others_extra[alt_idx]
1485
1321
alt_tree = self._other_trees[alt_idx]
1486
1322
other_values.append(self._lookup_by_file_id(
1487
alt_extra, alt_tree, file_id))
1323
alt_extra, alt_tree, file_id))
1488
1324
yield other_path, file_id, None, other_values
1327
def find_previous_paths(from_tree, to_tree, paths):
1328
"""Find previous tree paths.
1330
:param from_tree: From tree
1331
:param to_tree: To tree
1332
:param paths: Iterable over paths to search for
1333
:return: Dictionary mapping from from_tree paths to paths in to_tree, or
1334
None if there is no equivalent path.
1338
ret[path] = find_previous_path(from_tree, to_tree, path)
1342
def find_previous_path(from_tree, to_tree, path, file_id=None):
1343
"""Find previous tree path.
1345
:param from_tree: From tree
1346
:param to_tree: To tree
1347
:param path: Path to search for
1348
:return: path in to_tree, or None if there is no equivalent path.
1351
file_id = from_tree.path2id(path)
1353
raise errors.NoSuchFile(path)
1355
return to_tree.id2path(file_id)
1356
except errors.NoSuchId:
1360
def get_canonical_path(tree, path, normalize):
1361
"""Find the canonical path of an item, ignoring case.
1363
:param tree: Tree to traverse
1364
:param path: Case-insensitive path to look up
1365
:param normalize: Function to normalize a filename for comparison
1366
:return: The canonical path
1370
bit_iter = iter(path.split("/"))
1371
for elt in bit_iter:
1372
lelt = normalize(elt)
1375
for child in tree.iter_child_entries(cur_path):
1377
if child.name == elt:
1378
# if we found an exact match, we can stop now; if
1379
# we found an approximate match we need to keep
1380
# searching because there might be an exact match
1382
new_path = osutils.pathjoin(cur_path, child.name)
1384
elif normalize(child.name) == lelt:
1385
new_path = osutils.pathjoin(cur_path, child.name)
1386
except errors.NoSuchId:
1387
# before a change is committed we can see this error...
1389
except errors.NotADirectory:
1394
# got to the end of this directory and no entries matched.
1395
# Return what matched so far, plus the rest as specified.
1396
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
added
removed
breezy/tree.py
