54
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)
57
127
def has_filename(self, filename):
58
128
"""True if the tree has given filename."""
59
raise NotImplementedError()
129
raise NotImplementedError(self.has_filename)
61
131
def has_id(self, file_id):
62
132
return self.inventory.has_id(file_id)
65
"""Return set of all ids in this tree."""
66
return self.inventory.id_set()
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.
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)
68
156
def id2path(self, file_id):
157
"""Return the path for a file id.
69
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)
71
237
def _get_inventory(self):
72
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_by_path(self, path):
258
return self.get_file(self._inventory.path2id(path), path)
260
def iter_files_bytes(self, desired_files):
261
"""Iterate through file contents.
263
Files will not necessarily be returned in the order they occur in
264
desired_files. No specific order is guaranteed.
266
Yields pairs of identifier, bytes_iterator. identifier is an opaque
267
value supplied by the caller as part of desired_files. It should
268
uniquely identify the file version in the caller's context. (Examples:
269
an index number or a TreeTransform trans_id.)
271
bytes_iterator is an iterable of bytestrings for the file. The
272
kind of iterable and length of the bytestrings are unspecified, but for
273
this implementation, it is a tuple containing a single bytestring with
274
the complete text of the file.
276
:param desired_files: a list of (file_id, identifier) pairs
278
for file_id, identifier in desired_files:
279
# We wrap the string in a tuple so that we can return an iterable
280
# of bytestrings. (Technically, a bytestring is also an iterable
281
# of bytestrings, but iterating through each character is not
283
cur_file = (self.get_file_text(file_id),)
284
yield identifier, cur_file
286
def get_symlink_target(self, file_id):
287
"""Get the target for a given file_id.
289
It is assumed that the caller already knows that file_id is referencing
291
:param file_id: Handle for the symlink entry.
292
:return: The path the symlink points to.
294
raise NotImplementedError(self.get_symlink_target)
296
def get_root_id(self):
297
"""Return the file_id for the root of this tree."""
298
raise NotImplementedError(self.get_root_id)
300
def annotate_iter(self, file_id,
301
default_revision=_mod_revision.CURRENT_REVISION):
302
"""Return an iterator of revision_id, line tuples.
304
For working trees (and mutable trees in general), the special
305
revision_id 'current:' will be used for lines that are new in this
306
tree, e.g. uncommitted changes.
307
:param file_id: The file to produce an annotated version from
308
:param default_revision: For lines that don't match a basis, mark them
309
with this revision id. Not all implementations will make use of
312
raise NotImplementedError(self.annotate_iter)
314
def _get_plan_merge_data(self, file_id, other, base):
315
from bzrlib import merge, versionedfile
316
vf = versionedfile._PlanMergeVersionedFile(file_id)
317
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
318
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
320
last_revision_base = None
322
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
323
return vf, last_revision_a, last_revision_b, last_revision_base
325
def plan_file_merge(self, file_id, other, base=None):
326
"""Generate a merge plan based on annotations.
328
If the file contains uncommitted changes in this tree, they will be
329
attributed to the 'current:' pseudo-revision. If the file contains
330
uncommitted changes in the other tree, they will be assigned to the
331
'other:' pseudo-revision.
333
data = self._get_plan_merge_data(file_id, other, base)
334
vf, last_revision_a, last_revision_b, last_revision_base = data
335
return vf.plan_merge(last_revision_a, last_revision_b,
338
def plan_file_lca_merge(self, file_id, other, base=None):
339
"""Generate a merge plan based lca-newness.
341
If the file contains uncommitted changes in this tree, they will be
342
attributed to the 'current:' pseudo-revision. If the file contains
343
uncommitted changes in the other tree, they will be assigned to the
344
'other:' pseudo-revision.
346
data = self._get_plan_merge_data(file_id, other, base)
347
vf, last_revision_a, last_revision_b, last_revision_base = data
348
return vf.plan_lca_merge(last_revision_a, last_revision_b,
351
def _get_file_revision(self, file_id, vf, tree_revision):
352
def file_revision(revision_tree):
353
revision_tree.lock_read()
355
return revision_tree.inventory[file_id].revision
357
revision_tree.unlock()
359
def iter_parent_trees():
360
for revision_id in self.get_parent_ids():
362
yield self.revision_tree(revision_id)
364
yield self.repository.revision_tree(revision_id)
366
if getattr(self, '_get_weave', None) is None:
367
last_revision = tree_revision
368
parent_revisions = [file_revision(t) for t in iter_parent_trees()]
369
vf.add_lines(last_revision, parent_revisions,
370
self.get_file(file_id).readlines())
371
repo = self.branch.repository
372
transaction = repo.get_transaction()
373
base_vf = repo.weave_store.get_weave(file_id, transaction)
375
last_revision = file_revision(self)
376
base_vf = self._get_weave(file_id)
377
vf.fallback_versionedfiles.append(base_vf)
74
380
inventory = property(_get_inventory,
75
381
doc="Inventory of this Tree")
77
383
def _check_retrieved(self, ie, f):
78
386
fp = fingerprint_file(f)
81
if ie.text_size != None:
389
if ie.text_size is not None:
82
390
if ie.text_size != fp['size']:
83
bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
391
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
84
392
["inventory expects %d bytes" % ie.text_size,
85
393
"file is actually %d bytes" % fp['size'],
86
394
"store is probably damaged/corrupt"])
88
396
if ie.text_sha1 != fp['sha1']:
89
bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
397
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
398
["inventory expects %s" % ie.text_sha1,
91
399
"file is actually %s" % fp['sha1'],
92
400
"store is probably damaged/corrupt"])
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
403
def path2id(self, path):
404
"""Return the id for path in this tree."""
405
return self._inventory.path2id(path)
407
def paths2ids(self, paths, trees=[], require_versioned=True):
408
"""Return all the ids that can be reached by walking from paths.
410
Each path is looked up in this tree and any extras provided in
411
trees, and this is repeated recursively: the children in an extra tree
412
of a directory that has been renamed under a provided path in this tree
413
are all returned, even if none exist under a provided path in this
414
tree, and vice versa.
416
:param paths: An iterable of paths to start converting to ids from.
417
Alternatively, if paths is None, no ids should be calculated and None
418
will be returned. This is offered to make calling the api unconditional
419
for code that *might* take a list of files.
420
:param trees: Additional trees to consider.
421
:param require_versioned: If False, do not raise NotVersionedError if
422
an element of paths is not versioned in this tree and all of trees.
424
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
426
def print_file(self, file_id):
427
"""Print file with id `file_id` to stdout."""
98
pumpfile(self.get_file(fileid), sys.stdout)
101
def export(self, dest):
102
"""Export this tree to a new directory.
104
`dest` should not exist, and will be created holding the
105
contents of this tree.
107
TODO: To handle subdirectories we need to create the
110
:note: If the export fails, the destination directory will be
111
left in a half-assed state.
114
mutter('export version %r' % self)
116
for dp, ie in inv.iter_entries():
118
fullpath = appendpath(dest, dp)
119
if kind == 'directory':
122
pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
124
bailout("don't know how to export {%s} of kind %r" % (fid, kind))
125
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
129
class WorkingTree(Tree):
130
"""Working copy tree.
132
The inventory is held in the `Branch` working-inventory, and the
133
files are in a directory on disk.
135
It is possible for a `WorkingTree` to have a filename which is
136
not listed in the Inventory and vice versa.
138
def __init__(self, basedir, inv):
139
self._inventory = inv
140
self.basedir = basedir
141
self.path2id = inv.path2id
144
return "<%s of %s>" % (self.__class__.__name__,
147
def abspath(self, filename):
148
return os.path.join(self.basedir, filename)
150
def has_filename(self, filename):
151
return os.path.exists(self.abspath(filename))
153
def get_file(self, file_id):
154
return self.get_file_byname(self.id2path(file_id))
156
def get_file_byname(self, filename):
157
return file(self.abspath(filename), 'rb')
159
def _get_store_filename(self, file_id):
160
## XXX: badly named; this isn't in the store at all
161
return self.abspath(self.id2path(file_id))
163
def has_id(self, file_id):
164
# files that have been deleted are excluded
165
if not self.inventory.has_id(file_id):
167
return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
169
def get_file_size(self, file_id):
170
return os.stat(self._get_store_filename(file_id))[ST_SIZE]
172
def get_file_sha1(self, file_id):
173
f = self.get_file(file_id)
177
def file_class(self, filename):
178
if self.path2id(filename):
180
elif self.is_ignored(filename):
186
def list_files(self):
187
"""Recursively list all files as (path, class, kind, id).
189
Lists, but does not descend into unversioned directories.
191
This does not include files that have been deleted in this
194
Skips the control directory.
198
def descend(from_dir_relpath, from_dir_id, dp):
202
## TODO: If we find a subdirectory with its own .bzr
203
## directory, then that is a separate tree and we
204
## should exclude it.
205
if bzrlib.BZRDIR == f:
209
fp = appendpath(from_dir_relpath, f)
212
fap = appendpath(dp, f)
214
f_ie = inv.get_child(from_dir_id, f)
217
elif self.is_ignored(fp):
226
bailout("file %r entered as kind %r id %r, now of kind %r"
227
% (fap, f_ie.kind, f_ie.file_id, fk))
229
yield fp, c, fk, (f_ie and f_ie.file_id)
231
if fk != 'directory':
235
# don't descend unversioned directories
238
for ff in descend(fp, f_ie.file_id, fap):
241
for f in descend('', inv.root.file_id, self.basedir):
429
sys.stdout.write(self.get_file_text(file_id))
434
def revision_tree(self, revision_id):
435
"""Obtain a revision tree for the revision revision_id.
437
The intention of this method is to allow access to possibly cached
438
tree data. Implementors of this method should raise NoSuchRevision if
439
the tree is not locally available, even if they could obtain the
440
tree via a repository or some other means. Callers are responsible
441
for finding the ultimate source for a revision tree.
443
:param revision_id: The revision_id of the requested tree.
445
:raises: NoSuchRevision if the tree cannot be obtained.
447
raise errors.NoSuchRevisionInTree(self, revision_id)
246
449
def unknowns(self):
247
for subp in self.extras():
248
if not self.is_ignored(subp):
253
"""Yield all unknown files in this WorkingTree.
255
If there are any unknown directories then only the directory is
256
returned, not all its children. But if there are unknown files
257
under a versioned subdirectory, they are returned.
259
Currently returned depth-first, sorted by name within directories.
261
## TODO: Work from given directory downwards
263
for path, dir_entry in self.inventory.directories():
264
mutter("search for unknowns in %r" % path)
265
dirabs = self.abspath(path)
266
if not isdir(dirabs):
267
# e.g. directory deleted
271
for subf in os.listdir(dirabs):
273
and (subf not in dir_entry.children)):
278
subp = appendpath(path, subf)
282
def ignored_files(self):
283
"""Yield list of PATH, IGNORE_PATTERN"""
284
for subp in self.extras():
285
pat = self.is_ignored(subp)
290
def get_ignore_list(self):
291
"""Return list of ignore patterns.
293
Cached in the Tree object after the first call.
295
if hasattr(self, '_ignorelist'):
296
return self._ignorelist
298
l = bzrlib.DEFAULT_IGNORE[:]
299
if self.has_filename(bzrlib.IGNORE_FILENAME):
300
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
301
l.extend([line.rstrip("\n\r") for line in f.readlines()])
306
def is_ignored(self, filename):
307
r"""Check whether the filename matches an ignore pattern.
309
Patterns containing '/' or '\' need to match the whole path;
310
others match against only the last component.
312
If the file is ignored, returns the pattern which caused it to
313
be ignored, otherwise None. So this can simply be used as a
314
boolean if desired."""
316
# TODO: Use '**' to match directories, and other extended
317
# globbing stuff from cvs/rsync.
319
# XXX: fnmatch is actually not quite what we want: it's only
320
# approximately the same as real Unix fnmatch, and doesn't
321
# treat dotfiles correctly and allows * to match /.
322
# Eventually it should be replaced with something more
325
for pat in self.get_ignore_list():
326
if '/' in pat or '\\' in pat:
328
# as a special case, you can put ./ at the start of a
329
# pattern; this is good to match in the top-level
332
if (pat[:2] == './') or (pat[:2] == '.\\'):
336
if fnmatch.fnmatchcase(filename, newpat):
339
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
347
class RevisionTree(Tree):
348
"""Tree viewing a previous revision.
350
File text can be retrieved from the text store.
352
TODO: Some kind of `__repr__` method, but a good one
353
probably means knowing the branch and revision number,
354
or at least passing a description to the constructor.
357
def __init__(self, store, inv):
359
self._inventory = inv
361
def get_file(self, file_id):
362
ie = self._inventory[file_id]
363
f = self._store[ie.text_id]
364
mutter(" get fileid{%s} from %r" % (file_id, self))
365
self._check_retrieved(ie, f)
368
def get_file_size(self, file_id):
369
return self._inventory[file_id].text_size
371
def get_file_sha1(self, file_id):
372
ie = self._inventory[file_id]
375
def has_filename(self, filename):
376
return bool(self.inventory.path2id(filename))
378
def list_files(self):
379
# The only files returned by this are those from the version
380
for path, entry in self.inventory.iter_entries():
381
yield path, 'V', entry.kind, entry.file_id
450
"""What files are present in this tree and unknown.
452
:return: an iterator over the unknown files.
459
def filter_unversioned_files(self, paths):
460
"""Filter out paths that are versioned.
462
:return: set of paths.
464
# NB: we specifically *don't* call self.has_filename, because for
465
# WorkingTrees that can indicate files that exist on disk but that
467
pred = self.inventory.has_filename
468
return set((p for p in paths if not pred(p)))
470
def walkdirs(self, prefix=""):
471
"""Walk the contents of this tree from path down.
473
This yields all the data about the contents of a directory at a time.
474
After each directory has been yielded, if the caller has mutated the
475
list to exclude some directories, they are then not descended into.
477
The data yielded is of the form:
478
((directory-relpath, directory-path-from-root, directory-fileid),
479
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
480
versioned_kind), ...]),
481
- directory-relpath is the containing dirs relpath from prefix
482
- directory-path-from-root is the containing dirs path from /
483
- directory-fileid is the id of the directory if it is versioned.
484
- relpath is the relative path within the subtree being walked.
485
- basename is the basename
486
- kind is the kind of the file now. If unknonwn then the file is not
487
present within the tree - but it may be recorded as versioned. See
489
- lstat is the stat data *if* the file was statted.
490
- path_from_tree_root is the path from the root of the tree.
491
- file_id is the file_id if the entry is versioned.
492
- versioned_kind is the kind of the file as last recorded in the
493
versioning system. If 'unknown' the file is not versioned.
494
One of 'kind' and 'versioned_kind' must not be 'unknown'.
496
:param prefix: Start walking from prefix within the tree rather than
497
at the root. This allows one to walk a subtree but get paths that are
498
relative to a tree rooted higher up.
499
:return: an iterator over the directory data.
501
raise NotImplementedError(self.walkdirs)
384
504
class EmptyTree(Tree):
385
506
def __init__(self):
386
self._inventory = Inventory()
507
self._inventory = Inventory(root_id=None)
508
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
509
' use repository.revision_tree instead.',
510
DeprecationWarning, stacklevel=2)
512
def get_parent_ids(self):
515
def get_symlink_target(self, file_id):
388
518
def has_filename(self, filename):
391
def list_files(self):
392
if False: # just to make it a generator
521
def kind(self, file_id):
524
def list_files(self, include_root=False):
527
def __contains__(self, file_id):
528
return (file_id in self._inventory)
530
def get_file_sha1(self, file_id, path=None, stat_value=None):
397
534
######################################################################
458
594
if old_name != new_name:
459
595
yield (old_name, new_name)
598
def find_ids_across_trees(filenames, trees, require_versioned=True):
599
"""Find the ids corresponding to specified filenames.
601
All matches in all trees will be used, and all children of matched
602
directories will be used.
604
:param filenames: The filenames to find file_ids for (if None, returns
606
:param trees: The trees to find file_ids within
607
:param require_versioned: if true, all specified filenames must occur in
609
:return: a set of file ids for the specified filenames and their children.
613
specified_path_ids = _find_ids_across_trees(filenames, trees,
615
return _find_children_across_trees(specified_path_ids, trees)
618
def _find_ids_across_trees(filenames, trees, require_versioned):
619
"""Find the ids corresponding to specified filenames.
621
All matches in all trees will be used, but subdirectories are not scanned.
623
:param filenames: The filenames to find file_ids for
624
:param trees: The trees to find file_ids within
625
:param require_versioned: if true, all specified filenames must occur in
627
:return: a set of file ids for the specified filenames
630
interesting_ids = set()
631
for tree_path in filenames:
634
file_id = tree.path2id(tree_path)
635
if file_id is not None:
636
interesting_ids.add(file_id)
639
not_versioned.append(tree_path)
640
if len(not_versioned) > 0 and require_versioned:
641
raise errors.PathsNotVersionedError(not_versioned)
642
return interesting_ids
645
def _find_children_across_trees(specified_ids, trees):
646
"""Return a set including specified ids and their children.
648
All matches in all trees will be used.
650
:param trees: The trees to find file_ids within
651
:return: a set containing all specified ids and their children
653
interesting_ids = set(specified_ids)
654
pending = interesting_ids
655
# now handle children of interesting ids
656
# we loop so that we handle all children of each id in both trees
657
while len(pending) > 0:
659
for file_id in pending:
661
if not tree.has_id(file_id):
663
entry = tree.inventory[file_id]
664
for child in getattr(entry, 'children', {}).itervalues():
665
if child.file_id not in interesting_ids:
666
new_pending.add(child.file_id)
667
interesting_ids.update(new_pending)
668
pending = new_pending
669
return interesting_ids
672
class InterTree(InterObject):
673
"""This class represents operations taking place between two Trees.
675
Its instances have methods like 'compare' and contain references to the
676
source and target trees these operations are to be carried out on.
678
Clients of bzrlib should not need to use InterTree directly, rather they
679
should use the convenience methods on Tree such as 'Tree.compare()' which
680
will pass through to InterTree as appropriate.
686
def compare(self, want_unchanged=False, specific_files=None,
687
extra_trees=None, require_versioned=False, include_root=False,
688
want_unversioned=False):
689
"""Return the changes from source to target.
691
:return: A TreeDelta.
692
:param specific_files: An optional list of file paths to restrict the
693
comparison to. When mapping filenames to ids, all matches in all
694
trees (including optional extra_trees) are used, and all children of
695
matched directories are included.
696
:param want_unchanged: An optional boolean requesting the inclusion of
697
unchanged entries in the result.
698
:param extra_trees: An optional list of additional trees to use when
699
mapping the contents of specific_files (paths) to file_ids.
700
:param require_versioned: An optional boolean (defaults to False). When
701
supplied and True all the 'specific_files' must be versioned, or
702
a PathsNotVersionedError will be thrown.
703
:param want_unversioned: Scan for unversioned paths.
705
# NB: show_status depends on being able to pass in non-versioned files
706
# and report them as unknown
707
trees = (self.source,)
708
if extra_trees is not None:
709
trees = trees + tuple(extra_trees)
710
# target is usually the newer tree:
711
specific_file_ids = self.target.paths2ids(specific_files, trees,
712
require_versioned=require_versioned)
713
if specific_files and not specific_file_ids:
714
# All files are unversioned, so just return an empty delta
715
# _compare_trees would think we want a complete delta
716
result = delta.TreeDelta()
717
fake_entry = InventoryFile('unused', 'unused', 'unused')
718
result.unversioned = [(path, None,
719
self.target._comparison_data(fake_entry, path)[0]) for path in
722
return delta._compare_trees(self.source, self.target, want_unchanged,
723
specific_files, include_root, extra_trees=extra_trees,
724
require_versioned=require_versioned,
725
want_unversioned=want_unversioned)
727
def iter_changes(self, include_unchanged=False,
728
specific_files=None, pb=None, extra_trees=[],
729
require_versioned=True, want_unversioned=False):
730
"""Generate an iterator of changes between trees.
733
(file_id, (path_in_source, path_in_target),
734
changed_content, versioned, parent, name, kind,
737
Changed_content is True if the file's content has changed. This
738
includes changes to its kind, and to a symlink's target.
740
versioned, parent, name, kind, executable are tuples of (from, to).
741
If a file is missing in a tree, its kind is None.
743
Iteration is done in parent-to-child order, relative to the target
746
There is no guarantee that all paths are in sorted order: the
747
requirement to expand the search due to renames may result in children
748
that should be found early being found late in the search, after
749
lexically later results have been returned.
750
:param require_versioned: Raise errors.PathsNotVersionedError if a
751
path in the specific_files list is not versioned in one of
752
source, target or extra_trees.
753
:param want_unversioned: Should unversioned files be returned in the
754
output. An unversioned file is defined as one with (False, False)
755
for the versioned pair.
758
lookup_trees = [self.source]
760
lookup_trees.extend(extra_trees)
761
if specific_files == []:
762
specific_file_ids = []
764
specific_file_ids = self.target.paths2ids(specific_files,
765
lookup_trees, require_versioned=require_versioned)
767
all_unversioned = sorted([(p.split('/'), p) for p in
769
if specific_files is None or
770
osutils.is_inside_any(specific_files, p)])
771
all_unversioned = deque(all_unversioned)
773
all_unversioned = deque()
775
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
776
specific_file_ids=specific_file_ids))
777
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
778
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
779
specific_file_ids=specific_file_ids))
780
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
782
# the unversioned path lookup only occurs on real trees - where there
783
# can be extras. So the fake_entry is solely used to look up
784
# executable it values when execute is not supported.
785
fake_entry = InventoryFile('unused', 'unused', 'unused')
786
for to_path, to_entry in to_entries_by_dir:
787
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
788
unversioned_path = all_unversioned.popleft()
789
to_kind, to_executable, to_stat = \
790
self.target._comparison_data(fake_entry, unversioned_path[1])
791
yield (None, (None, unversioned_path[1]), True, (False, False),
793
(None, unversioned_path[0][-1]),
795
(None, to_executable))
796
file_id = to_entry.file_id
797
to_paths[file_id] = to_path
799
changed_content = False
800
from_path, from_entry = from_data.get(file_id, (None, None))
801
from_versioned = (from_entry is not None)
802
if from_entry is not None:
803
from_versioned = True
804
from_name = from_entry.name
805
from_parent = from_entry.parent_id
806
from_kind, from_executable, from_stat = \
807
self.source._comparison_data(from_entry, from_path)
810
from_versioned = False
814
from_executable = None
815
versioned = (from_versioned, True)
816
to_kind, to_executable, to_stat = \
817
self.target._comparison_data(to_entry, to_path)
818
kind = (from_kind, to_kind)
819
if kind[0] != kind[1]:
820
changed_content = True
821
elif from_kind == 'file':
822
from_size = self.source._file_size(from_entry, from_stat)
823
to_size = self.target._file_size(to_entry, to_stat)
824
if from_size != to_size:
825
changed_content = True
826
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
827
self.target.get_file_sha1(file_id, to_path, to_stat)):
828
changed_content = True
829
elif from_kind == 'symlink':
830
if (self.source.get_symlink_target(file_id) !=
831
self.target.get_symlink_target(file_id)):
832
changed_content = True
833
elif from_kind == 'tree-reference':
834
if (self.source.get_reference_revision(file_id, from_path)
835
!= self.target.get_reference_revision(file_id, to_path)):
836
changed_content = True
837
parent = (from_parent, to_entry.parent_id)
838
name = (from_name, to_entry.name)
839
executable = (from_executable, to_executable)
841
pb.update('comparing files', entry_count, num_entries)
842
if (changed_content is not False or versioned[0] != versioned[1]
843
or parent[0] != parent[1] or name[0] != name[1] or
844
executable[0] != executable[1] or include_unchanged):
845
yield (file_id, (from_path, to_path), changed_content,
846
versioned, parent, name, kind, executable)
848
while all_unversioned:
849
# yield any trailing unversioned paths
850
unversioned_path = all_unversioned.popleft()
851
to_kind, to_executable, to_stat = \
852
self.target._comparison_data(fake_entry, unversioned_path[1])
853
yield (None, (None, unversioned_path[1]), True, (False, False),
855
(None, unversioned_path[0][-1]),
857
(None, to_executable))
859
def get_to_path(to_entry):
860
if to_entry.parent_id is None:
861
to_path = '' # the root
863
if to_entry.parent_id not in to_paths:
865
return get_to_path(self.target.inventory[to_entry.parent_id])
866
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
868
to_paths[to_entry.file_id] = to_path
871
for path, from_entry in from_entries_by_dir:
872
file_id = from_entry.file_id
873
if file_id in to_paths:
876
if not file_id in self.target.inventory:
877
# common case - paths we have not emitted are not present in
881
to_path = get_to_path(self.target.inventory[file_id])
884
pb.update('comparing files', entry_count, num_entries)
885
versioned = (True, False)
886
parent = (from_entry.parent_id, None)
887
name = (from_entry.name, None)
888
from_kind, from_executable, stat_value = \
889
self.source._comparison_data(from_entry, path)
890
kind = (from_kind, None)
891
executable = (from_executable, None)
892
changed_content = True
893
# the parent's path is necessarily known at this point.
894
yield(file_id, (path, to_path), changed_content, versioned, parent,
895
name, kind, executable)
898
# This was deprecated before 0.12, but did not have an official warning
899
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
900
def RevisionTree(*args, **kwargs):
901
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
903
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
906
from bzrlib.revisiontree import RevisionTree as _RevisionTree
907
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
