50
59
trees or versioned trees.
62
def changes_from(self, other, want_unchanged=False, specific_files=None,
63
extra_trees=None, require_versioned=False, include_root=False,
64
want_unversioned=False):
65
"""Return a TreeDelta of the changes from other to this tree.
67
:param other: A tree to compare with.
68
:param specific_files: An optional list of file paths to restrict the
69
comparison to. When mapping filenames to ids, all matches in all
70
trees (including optional extra_trees) are used, and all children of
71
matched directories are included.
72
:param want_unchanged: An optional boolean requesting the inclusion of
73
unchanged entries in the result.
74
:param extra_trees: An optional list of additional trees to use when
75
mapping the contents of specific_files (paths) to file_ids.
76
:param require_versioned: An optional boolean (defaults to False). When
77
supplied and True all the 'specific_files' must be versioned, or
78
a PathsNotVersionedError will be thrown.
79
:param want_unversioned: Scan for unversioned paths.
81
The comparison will be performed by an InterTree object looked up on
84
# Martin observes that Tree.changes_from returns a TreeDelta and this
85
# may confuse people, because the class name of the returned object is
86
# a synonym of the object referenced in the method name.
87
return InterTree.get(other, self).compare(
88
want_unchanged=want_unchanged,
89
specific_files=specific_files,
90
extra_trees=extra_trees,
91
require_versioned=require_versioned,
92
include_root=include_root,
93
want_unversioned=want_unversioned,
96
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
97
def _iter_changes(self, *args, **kwargs):
98
return self.iter_changes(*args, **kwargs)
100
def iter_changes(self, from_tree, include_unchanged=False,
101
specific_files=None, pb=None, extra_trees=None,
102
require_versioned=True, want_unversioned=False):
103
intertree = InterTree.get(from_tree, self)
104
return intertree.iter_changes(include_unchanged, specific_files, pb,
105
extra_trees, require_versioned, want_unversioned=want_unversioned)
108
"""Get a list of the conflicts in the tree.
110
Each conflict is an instance of bzrlib.conflicts.Conflict.
112
return _mod_conflicts.ConflictList()
115
"""For trees that can have unversioned files, return all such paths."""
118
def get_parent_ids(self):
119
"""Get the parent ids for this tree.
121
:return: a list of parent ids. [] is returned to indicate
122
a tree with no parents.
123
:raises: BzrError if the parents are not known.
125
raise NotImplementedError(self.get_parent_ids)
53
127
def has_filename(self, filename):
54
128
"""True if the tree has given filename."""
55
raise NotImplementedError()
129
raise NotImplementedError(self.has_filename)
57
131
def has_id(self, file_id):
58
132
return self.inventory.has_id(file_id)
60
134
__contains__ = has_id
136
def has_or_had_id(self, file_id):
137
if file_id == self.inventory.root.file_id:
139
return self.inventory.has_id(file_id)
141
def is_ignored(self, filename):
142
"""Check whether the filename is ignored by this tree.
144
:param filename: The relative filename within the tree.
145
:return: True if the filename is ignored.
62
149
def __iter__(self):
63
150
return iter(self.inventory)
152
def all_file_ids(self):
153
"""Iterate through all file ids, including ids for missing files."""
154
return set(self.inventory)
65
156
def id2path(self, file_id):
157
"""Return the path for a file id.
66
161
return self.inventory.id2path(file_id)
163
def is_control_filename(self, filename):
164
"""True if filename is the name of a control file in this tree.
166
:param filename: A filename within the tree. This is a relative path
167
from the root of this tree.
169
This is true IF and ONLY IF the filename is part of the meta data
170
that bzr controls in this tree. I.E. a random .bzr directory placed
171
on disk will not be a control file for this tree.
173
return self.bzrdir.is_control_filename(filename)
176
def iter_entries_by_dir(self, specific_file_ids=None):
177
"""Walk the tree in 'by_dir' order.
179
This will yield each entry in the tree as a (path, entry) tuple. The
180
order that they are yielded is: the contents of a directory are
181
preceeded by the parent of a directory, and all the contents of a
182
directory are grouped together.
184
return self.inventory.iter_entries_by_dir(
185
specific_file_ids=specific_file_ids)
187
def iter_references(self):
188
for path, entry in self.iter_entries_by_dir():
189
if entry.kind == 'tree-reference':
190
yield path, entry.file_id
192
def kind(self, file_id):
193
raise NotImplementedError("Tree subclass %s must implement kind"
194
% self.__class__.__name__)
196
def stored_kind(self, file_id):
197
"""File kind stored for this file_id.
199
May not match kind on disk for working trees. Always available
200
for versioned files, even when the file itself is missing.
202
return self.kind(file_id)
204
def path_content_summary(self, path):
205
"""Get a summary of the information about path.
207
:param path: A relative path within the tree.
208
:return: A tuple containing kind, size, exec, sha1-or-link.
209
Kind is always present (see tree.kind()).
210
size is present if kind is file, None otherwise.
211
exec is None unless kind is file and the platform supports the 'x'
213
sha1-or-link is the link target if kind is symlink, or the sha1 if
214
it can be obtained without reading the file.
216
raise NotImplementedError(self.path_content_summary)
218
def get_reference_revision(self, file_id, path=None):
219
raise NotImplementedError("Tree subclass %s must implement "
220
"get_reference_revision"
221
% self.__class__.__name__)
223
def _comparison_data(self, entry, path):
224
"""Return a tuple of kind, executable, stat_value for a file.
226
entry may be None if there is no inventory entry for the file, but
227
path must always be supplied.
229
kind is None if there is no file present (even if an inventory id is
230
present). executable is False for non-file entries.
232
raise NotImplementedError(self._comparison_data)
234
def _file_size(self, entry, stat_value):
235
raise NotImplementedError(self._file_size)
68
237
def _get_inventory(self):
69
238
return self._inventory
240
def get_file(self, file_id, path=None):
241
"""Return a file object for the file file_id in the tree.
243
If both file_id and path are defined, it is implementation defined as
244
to which one is used.
246
raise NotImplementedError(self.get_file)
248
def get_file_mtime(self, file_id, path=None):
249
"""Return the modification time for a file.
251
:param file_id: The handle for this file.
252
:param path: The path that this file can be found at.
253
These must point to the same object.
255
raise NotImplementedError(self.get_file_mtime)
257
def get_file_size(self, file_id):
258
"""Return the size of a file in bytes.
260
This applies only to regular files. If invoked on directories or
261
symlinks, it will return None.
262
:param file_id: The file-id of the file
264
raise NotImplementedError(self.get_file_size)
71
266
def get_file_by_path(self, path):
72
return self.get_file(self._inventory.path2id(path))
267
return self.get_file(self._inventory.path2id(path), path)
269
def iter_files_bytes(self, desired_files):
270
"""Iterate through file contents.
272
Files will not necessarily be returned in the order they occur in
273
desired_files. No specific order is guaranteed.
275
Yields pairs of identifier, bytes_iterator. identifier is an opaque
276
value supplied by the caller as part of desired_files. It should
277
uniquely identify the file version in the caller's context. (Examples:
278
an index number or a TreeTransform trans_id.)
280
bytes_iterator is an iterable of bytestrings for the file. The
281
kind of iterable and length of the bytestrings are unspecified, but for
282
this implementation, it is a tuple containing a single bytestring with
283
the complete text of the file.
285
:param desired_files: a list of (file_id, identifier) pairs
287
for file_id, identifier in desired_files:
288
# We wrap the string in a tuple so that we can return an iterable
289
# of bytestrings. (Technically, a bytestring is also an iterable
290
# of bytestrings, but iterating through each character is not
292
cur_file = (self.get_file_text(file_id),)
293
yield identifier, cur_file
295
def get_symlink_target(self, file_id):
296
"""Get the target for a given file_id.
298
It is assumed that the caller already knows that file_id is referencing
300
:param file_id: Handle for the symlink entry.
301
:return: The path the symlink points to.
303
raise NotImplementedError(self.get_symlink_target)
305
def get_root_id(self):
306
"""Return the file_id for the root of this tree."""
307
raise NotImplementedError(self.get_root_id)
309
def annotate_iter(self, file_id,
310
default_revision=_mod_revision.CURRENT_REVISION):
311
"""Return an iterator of revision_id, line tuples.
313
For working trees (and mutable trees in general), the special
314
revision_id 'current:' will be used for lines that are new in this
315
tree, e.g. uncommitted changes.
316
:param file_id: The file to produce an annotated version from
317
:param default_revision: For lines that don't match a basis, mark them
318
with this revision id. Not all implementations will make use of
321
raise NotImplementedError(self.annotate_iter)
323
def _get_plan_merge_data(self, file_id, other, base):
324
from bzrlib import merge, versionedfile
325
vf = versionedfile._PlanMergeVersionedFile(file_id)
326
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
327
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
329
last_revision_base = None
331
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
332
return vf, last_revision_a, last_revision_b, last_revision_base
334
def plan_file_merge(self, file_id, other, base=None):
335
"""Generate a merge plan based on annotations.
337
If the file contains uncommitted changes in this tree, they will be
338
attributed to the 'current:' pseudo-revision. If the file contains
339
uncommitted changes in the other tree, they will be assigned to the
340
'other:' pseudo-revision.
342
data = self._get_plan_merge_data(file_id, other, base)
343
vf, last_revision_a, last_revision_b, last_revision_base = data
344
return vf.plan_merge(last_revision_a, last_revision_b,
347
def plan_file_lca_merge(self, file_id, other, base=None):
348
"""Generate a merge plan based lca-newness.
350
If the file contains uncommitted changes in this tree, they will be
351
attributed to the 'current:' pseudo-revision. If the file contains
352
uncommitted changes in the other tree, they will be assigned to the
353
'other:' pseudo-revision.
355
data = self._get_plan_merge_data(file_id, other, base)
356
vf, last_revision_a, last_revision_b, last_revision_base = data
357
return vf.plan_lca_merge(last_revision_a, last_revision_b,
360
def _get_file_revision(self, file_id, vf, tree_revision):
361
def file_revision(revision_tree):
362
revision_tree.lock_read()
364
return revision_tree.inventory[file_id].revision
366
revision_tree.unlock()
368
def iter_parent_trees():
369
for revision_id in self.get_parent_ids():
371
yield self.revision_tree(revision_id)
373
yield self.repository.revision_tree(revision_id)
375
if getattr(self, '_get_weave', None) is None:
376
last_revision = tree_revision
377
parent_revisions = [file_revision(t) for t in iter_parent_trees()]
378
vf.add_lines(last_revision, parent_revisions,
379
self.get_file(file_id).readlines())
380
repo = self.branch.repository
381
transaction = repo.get_transaction()
382
base_vf = repo.weave_store.get_weave(file_id, transaction)
384
last_revision = file_revision(self)
385
base_vf = self._get_weave(file_id)
386
vf.fallback_versionedfiles.append(base_vf)
74
389
inventory = property(_get_inventory,
75
390
doc="Inventory of this Tree")
77
392
def _check_retrieved(self, ie, f):
78
395
fp = fingerprint_file(f)
81
if ie.text_size != None:
398
if ie.text_size is not None:
82
399
if ie.text_size != fp['size']:
83
400
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
84
401
["inventory expects %d bytes" % ie.text_size,
91
408
"file is actually %s" % fp['sha1'],
92
409
"store is probably damaged/corrupt"])
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
412
def path2id(self, path):
413
"""Return the id for path in this tree."""
414
return self._inventory.path2id(path)
416
def paths2ids(self, paths, trees=[], require_versioned=True):
417
"""Return all the ids that can be reached by walking from paths.
419
Each path is looked up in this tree and any extras provided in
420
trees, and this is repeated recursively: the children in an extra tree
421
of a directory that has been renamed under a provided path in this tree
422
are all returned, even if none exist under a provided path in this
423
tree, and vice versa.
425
:param paths: An iterable of paths to start converting to ids from.
426
Alternatively, if paths is None, no ids should be calculated and None
427
will be returned. This is offered to make calling the api unconditional
428
for code that *might* take a list of files.
429
:param trees: Additional trees to consider.
430
:param require_versioned: If False, do not raise NotVersionedError if
431
an element of paths is not versioned in this tree and all of trees.
433
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
435
def print_file(self, file_id):
436
"""Print file with id `file_id` to stdout."""
98
pumpfile(self.get_file(fileid), sys.stdout)
101
def export(self, dest, format='dir', root=None):
102
"""Export this tree."""
104
exporter = exporters[format]
106
from bzrlib.errors import BzrCommandError
107
raise BzrCommandError("export format %r not supported" % format)
108
exporter(self, dest, root)
112
class RevisionTree(Tree):
113
"""Tree viewing a previous revision.
115
File text can be retrieved from the text store.
117
TODO: Some kind of `__repr__` method, but a good one
118
probably means knowing the branch and revision number,
119
or at least passing a description to the constructor.
122
def __init__(self, store, inv):
124
self._inventory = inv
126
def get_file(self, file_id):
127
ie = self._inventory[file_id]
128
f = self._store[ie.text_id]
129
mutter(" get fileid{%s} from %r" % (file_id, self))
130
self._check_retrieved(ie, f)
133
def get_file_size(self, file_id):
134
return self._inventory[file_id].text_size
136
def get_file_sha1(self, file_id):
137
ie = self._inventory[file_id]
140
def has_filename(self, filename):
141
return bool(self.inventory.path2id(filename))
143
def list_files(self):
144
# The only files returned by this are those from the version
145
for path, entry in self.inventory.iter_entries():
146
yield path, 'V', entry.kind, entry.file_id
438
sys.stdout.write(self.get_file_text(file_id))
443
def revision_tree(self, revision_id):
444
"""Obtain a revision tree for the revision revision_id.
446
The intention of this method is to allow access to possibly cached
447
tree data. Implementors of this method should raise NoSuchRevision if
448
the tree is not locally available, even if they could obtain the
449
tree via a repository or some other means. Callers are responsible
450
for finding the ultimate source for a revision tree.
452
:param revision_id: The revision_id of the requested tree.
454
:raises: NoSuchRevision if the tree cannot be obtained.
456
raise errors.NoSuchRevisionInTree(self, revision_id)
459
"""What files are present in this tree and unknown.
461
:return: an iterator over the unknown files.
468
def filter_unversioned_files(self, paths):
469
"""Filter out paths that are versioned.
471
:return: set of paths.
473
# NB: we specifically *don't* call self.has_filename, because for
474
# WorkingTrees that can indicate files that exist on disk but that
476
pred = self.inventory.has_filename
477
return set((p for p in paths if not pred(p)))
479
def walkdirs(self, prefix=""):
480
"""Walk the contents of this tree from path down.
482
This yields all the data about the contents of a directory at a time.
483
After each directory has been yielded, if the caller has mutated the
484
list to exclude some directories, they are then not descended into.
486
The data yielded is of the form:
487
((directory-relpath, directory-path-from-root, directory-fileid),
488
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
489
versioned_kind), ...]),
490
- directory-relpath is the containing dirs relpath from prefix
491
- directory-path-from-root is the containing dirs path from /
492
- directory-fileid is the id of the directory if it is versioned.
493
- relpath is the relative path within the subtree being walked.
494
- basename is the basename
495
- kind is the kind of the file now. If unknonwn then the file is not
496
present within the tree - but it may be recorded as versioned. See
498
- lstat is the stat data *if* the file was statted.
499
- path_from_tree_root is the path from the root of the tree.
500
- file_id is the file_id if the entry is versioned.
501
- versioned_kind is the kind of the file as last recorded in the
502
versioning system. If 'unknown' the file is not versioned.
503
One of 'kind' and 'versioned_kind' must not be 'unknown'.
505
:param prefix: Start walking from prefix within the tree rather than
506
at the root. This allows one to walk a subtree but get paths that are
507
relative to a tree rooted higher up.
508
:return: an iterator over the directory data.
510
raise NotImplementedError(self.walkdirs)
149
513
class EmptyTree(Tree):
150
515
def __init__(self):
151
self._inventory = Inventory()
516
self._inventory = Inventory(root_id=None)
517
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
518
' use repository.revision_tree instead.',
519
DeprecationWarning, stacklevel=2)
521
def get_parent_ids(self):
524
def get_symlink_target(self, file_id):
153
527
def has_filename(self, filename):
156
def list_files(self):
157
if False: # just to make it a generator
530
def kind(self, file_id):
531
assert self._inventory[file_id].kind == "directory"
534
def list_files(self, include_root=False):
537
def __contains__(self, file_id):
538
return (file_id in self._inventory)
540
def get_file_sha1(self, file_id, path=None, stat_value=None):
162
544
######################################################################
224
606
yield (old_name, new_name)
228
######################################################################
231
def dir_exporter(tree, dest, root):
232
"""Export this tree to a new directory.
234
`dest` should not exist, and will be created holding the
235
contents of this tree.
237
TODO: To handle subdirectories we need to create the
240
:note: If the export fails, the destination directory will be
241
left in a half-assed state.
245
mutter('export version %r' % tree)
247
for dp, ie in inv.iter_entries():
249
fullpath = appendpath(dest, dp)
250
if kind == 'directory':
253
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
255
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
256
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
257
exporters['dir'] = dir_exporter
264
def get_root_name(dest):
265
"""Get just the root name for a tarball.
267
>>> get_root_name('mytar.tar')
269
>>> get_root_name('mytar.tar.bz2')
271
>>> get_root_name('tar.tar.tar.tgz')
273
>>> get_root_name('bzr-0.0.5.tar.gz')
275
>>> get_root_name('a/long/path/mytar.tgz')
277
>>> get_root_name('../parent/../dir/other.tbz2')
280
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
281
dest = os.path.basename(dest)
283
if dest.endswith(end):
284
return dest[:-len(end)]
286
def tar_exporter(tree, dest, root, compression=None):
287
"""Export this tree to a new tar file.
289
`dest` will be created holding the contents of this tree; if it
290
already exists, it will be clobbered, like with "tar -c".
292
from time import time
294
compression = str(compression or '')
296
root = get_root_name(dest)
298
ball = tarfile.open(dest, 'w:' + compression)
299
except tarfile.CompressionError, e:
300
raise BzrError(str(e))
301
mutter('export version %r' % tree)
303
for dp, ie in inv.iter_entries():
304
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
305
item = tarfile.TarInfo(os.path.join(root, dp))
306
# TODO: would be cool to actually set it to the timestamp of the
307
# revision it was last changed
309
if ie.kind == 'directory':
310
item.type = tarfile.DIRTYPE
315
elif ie.kind == 'file':
316
item.type = tarfile.REGTYPE
317
fileobj = tree.get_file(ie.file_id)
318
item.size = _find_file_size(fileobj)
321
raise BzrError("don't know how to export {%s} of kind %r" %
322
(ie.file_id, ie.kind))
324
ball.addfile(item, fileobj)
326
exporters['tar'] = tar_exporter
328
def tgz_exporter(tree, dest, root):
329
tar_exporter(tree, dest, root, compression='gz')
330
exporters['tgz'] = tgz_exporter
332
def tbz_exporter(tree, dest, root):
333
tar_exporter(tree, dest, root, compression='bz2')
334
exporters['tbz2'] = tbz_exporter
337
def _find_file_size(fileobj):
338
offset = fileobj.tell()
341
size = fileobj.tell()
343
# gzip doesn't accept second argument to seek()
347
nread = len(fileobj.read())
609
def find_ids_across_trees(filenames, trees, require_versioned=True):
610
"""Find the ids corresponding to specified filenames.
612
All matches in all trees will be used, and all children of matched
613
directories will be used.
615
:param filenames: The filenames to find file_ids for (if None, returns
617
:param trees: The trees to find file_ids within
618
:param require_versioned: if true, all specified filenames must occur in
620
:return: a set of file ids for the specified filenames and their children.
624
specified_path_ids = _find_ids_across_trees(filenames, trees,
626
return _find_children_across_trees(specified_path_ids, trees)
629
def _find_ids_across_trees(filenames, trees, require_versioned):
630
"""Find the ids corresponding to specified filenames.
632
All matches in all trees will be used, but subdirectories are not scanned.
634
:param filenames: The filenames to find file_ids for
635
:param trees: The trees to find file_ids within
636
:param require_versioned: if true, all specified filenames must occur in
638
:return: a set of file ids for the specified filenames
641
interesting_ids = set()
642
for tree_path in filenames:
645
file_id = tree.path2id(tree_path)
646
if file_id is not None:
647
interesting_ids.add(file_id)
650
not_versioned.append(tree_path)
651
if len(not_versioned) > 0 and require_versioned:
652
raise errors.PathsNotVersionedError(not_versioned)
653
return interesting_ids
656
def _find_children_across_trees(specified_ids, trees):
657
"""Return a set including specified ids and their children.
659
All matches in all trees will be used.
661
:param trees: The trees to find file_ids within
662
:return: a set containing all specified ids and their children
664
interesting_ids = set(specified_ids)
665
pending = interesting_ids
666
# now handle children of interesting ids
667
# we loop so that we handle all children of each id in both trees
668
while len(pending) > 0:
670
for file_id in pending:
672
if not tree.has_id(file_id):
674
entry = tree.inventory[file_id]
675
for child in getattr(entry, 'children', {}).itervalues():
676
if child.file_id not in interesting_ids:
677
new_pending.add(child.file_id)
678
interesting_ids.update(new_pending)
679
pending = new_pending
680
return interesting_ids
683
class InterTree(InterObject):
684
"""This class represents operations taking place between two Trees.
686
Its instances have methods like 'compare' and contain references to the
687
source and target trees these operations are to be carried out on.
689
Clients of bzrlib should not need to use InterTree directly, rather they
690
should use the convenience methods on Tree such as 'Tree.compare()' which
691
will pass through to InterTree as appropriate.
697
def compare(self, want_unchanged=False, specific_files=None,
698
extra_trees=None, require_versioned=False, include_root=False,
699
want_unversioned=False):
700
"""Return the changes from source to target.
702
:return: A TreeDelta.
703
:param specific_files: An optional list of file paths to restrict the
704
comparison to. When mapping filenames to ids, all matches in all
705
trees (including optional extra_trees) are used, and all children of
706
matched directories are included.
707
:param want_unchanged: An optional boolean requesting the inclusion of
708
unchanged entries in the result.
709
:param extra_trees: An optional list of additional trees to use when
710
mapping the contents of specific_files (paths) to file_ids.
711
:param require_versioned: An optional boolean (defaults to False). When
712
supplied and True all the 'specific_files' must be versioned, or
713
a PathsNotVersionedError will be thrown.
714
:param want_unversioned: Scan for unversioned paths.
716
# NB: show_status depends on being able to pass in non-versioned files
717
# and report them as unknown
718
trees = (self.source,)
719
if extra_trees is not None:
720
trees = trees + tuple(extra_trees)
721
# target is usually the newer tree:
722
specific_file_ids = self.target.paths2ids(specific_files, trees,
723
require_versioned=require_versioned)
724
if specific_files and not specific_file_ids:
725
# All files are unversioned, so just return an empty delta
726
# _compare_trees would think we want a complete delta
727
result = delta.TreeDelta()
728
fake_entry = InventoryFile('unused', 'unused', 'unused')
729
result.unversioned = [(path, None,
730
self.target._comparison_data(fake_entry, path)[0]) for path in
733
return delta._compare_trees(self.source, self.target, want_unchanged,
734
specific_files, include_root, extra_trees=extra_trees,
735
require_versioned=require_versioned,
736
want_unversioned=want_unversioned)
738
def iter_changes(self, include_unchanged=False,
739
specific_files=None, pb=None, extra_trees=[],
740
require_versioned=True, want_unversioned=False):
741
"""Generate an iterator of changes between trees.
744
(file_id, (path_in_source, path_in_target),
745
changed_content, versioned, parent, name, kind,
748
Changed_content is True if the file's content has changed. This
749
includes changes to its kind, and to a symlink's target.
751
versioned, parent, name, kind, executable are tuples of (from, to).
752
If a file is missing in a tree, its kind is None.
754
Iteration is done in parent-to-child order, relative to the target
757
There is no guarantee that all paths are in sorted order: the
758
requirement to expand the search due to renames may result in children
759
that should be found early being found late in the search, after
760
lexically later results have been returned.
761
:param require_versioned: Raise errors.PathsNotVersionedError if a
762
path in the specific_files list is not versioned in one of
763
source, target or extra_trees.
764
:param want_unversioned: Should unversioned files be returned in the
765
output. An unversioned file is defined as one with (False, False)
766
for the versioned pair.
769
lookup_trees = [self.source]
771
lookup_trees.extend(extra_trees)
772
if specific_files == []:
773
specific_file_ids = []
775
specific_file_ids = self.target.paths2ids(specific_files,
776
lookup_trees, require_versioned=require_versioned)
778
all_unversioned = sorted([(p.split('/'), p) for p in
780
if specific_files is None or
781
osutils.is_inside_any(specific_files, p)])
782
all_unversioned = deque(all_unversioned)
784
all_unversioned = deque()
786
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
787
specific_file_ids=specific_file_ids))
788
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
789
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
790
specific_file_ids=specific_file_ids))
791
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
793
# the unversioned path lookup only occurs on real trees - where there
794
# can be extras. So the fake_entry is solely used to look up
795
# executable it values when execute is not supported.
796
fake_entry = InventoryFile('unused', 'unused', 'unused')
797
for to_path, to_entry in to_entries_by_dir:
798
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
799
unversioned_path = all_unversioned.popleft()
800
to_kind, to_executable, to_stat = \
801
self.target._comparison_data(fake_entry, unversioned_path[1])
802
yield (None, (None, unversioned_path[1]), True, (False, False),
804
(None, unversioned_path[0][-1]),
806
(None, to_executable))
807
file_id = to_entry.file_id
808
to_paths[file_id] = to_path
810
changed_content = False
811
from_path, from_entry = from_data.get(file_id, (None, None))
812
from_versioned = (from_entry is not None)
813
if from_entry is not None:
814
from_versioned = True
815
from_name = from_entry.name
816
from_parent = from_entry.parent_id
817
from_kind, from_executable, from_stat = \
818
self.source._comparison_data(from_entry, from_path)
821
from_versioned = False
825
from_executable = None
826
versioned = (from_versioned, True)
827
to_kind, to_executable, to_stat = \
828
self.target._comparison_data(to_entry, to_path)
829
kind = (from_kind, to_kind)
830
if kind[0] != kind[1]:
831
changed_content = True
832
elif from_kind == 'file':
833
from_size = self.source._file_size(from_entry, from_stat)
834
to_size = self.target._file_size(to_entry, to_stat)
835
if from_size != to_size:
836
changed_content = True
837
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
838
self.target.get_file_sha1(file_id, to_path, to_stat)):
839
changed_content = True
840
elif from_kind == 'symlink':
841
if (self.source.get_symlink_target(file_id) !=
842
self.target.get_symlink_target(file_id)):
843
changed_content = True
844
elif from_kind == 'tree-reference':
845
if (self.source.get_reference_revision(file_id, from_path)
846
!= self.target.get_reference_revision(file_id, to_path)):
847
changed_content = True
848
parent = (from_parent, to_entry.parent_id)
849
name = (from_name, to_entry.name)
850
executable = (from_executable, to_executable)
852
pb.update('comparing files', entry_count, num_entries)
853
if (changed_content is not False or versioned[0] != versioned[1]
854
or parent[0] != parent[1] or name[0] != name[1] or
855
executable[0] != executable[1] or include_unchanged):
856
yield (file_id, (from_path, to_path), changed_content,
857
versioned, parent, name, kind, executable)
859
while all_unversioned:
860
# yield any trailing unversioned paths
861
unversioned_path = all_unversioned.popleft()
862
to_kind, to_executable, to_stat = \
863
self.target._comparison_data(fake_entry, unversioned_path[1])
864
yield (None, (None, unversioned_path[1]), True, (False, False),
866
(None, unversioned_path[0][-1]),
868
(None, to_executable))
870
def get_to_path(to_entry):
871
if to_entry.parent_id is None:
872
to_path = '' # the root
874
if to_entry.parent_id not in to_paths:
876
return get_to_path(self.target.inventory[to_entry.parent_id])
877
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
879
to_paths[to_entry.file_id] = to_path
882
for path, from_entry in from_entries_by_dir:
883
file_id = from_entry.file_id
884
if file_id in to_paths:
887
if not file_id in self.target.inventory:
888
# common case - paths we have not emitted are not present in
892
to_path = get_to_path(self.target.inventory[file_id])
895
pb.update('comparing files', entry_count, num_entries)
896
versioned = (True, False)
897
parent = (from_entry.parent_id, None)
898
name = (from_entry.name, None)
899
from_kind, from_executable, stat_value = \
900
self.source._comparison_data(from_entry, path)
901
kind = (from_kind, None)
902
executable = (from_executable, None)
903
changed_content = True
904
# the parent's path is necessarily known at this point.
905
yield(file_id, (path, to_path), changed_content, versioned, parent,
906
name, kind, executable)
909
# This was deprecated before 0.12, but did not have an official warning
910
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
911
def RevisionTree(*args, **kwargs):
912
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
914
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
917
from bzrlib.revisiontree import RevisionTree as _RevisionTree
918
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
