52
53
trees or versioned trees.
56
def changes_from(self, other, want_unchanged=False, specific_files=None,
57
extra_trees=None, require_versioned=False, include_root=False):
58
"""Return a TreeDelta of the changes from other to this tree.
60
:param other: A tree to compare with.
61
:param specific_files: An optional list of file paths to restrict the
62
comparison to. When mapping filenames to ids, all matches in all
63
trees (including optional extra_trees) are used, and all children of
64
matched directories are included.
65
:param want_unchanged: An optional boolean requesting the inclusion of
66
unchanged entries in the result.
67
:param extra_trees: An optional list of additional trees to use when
68
mapping the contents of specific_files (paths) to file_ids.
69
:param require_versioned: An optional boolean (defaults to False). When
70
supplied and True all the 'specific_files' must be versioned, or
71
a PathsNotVersionedError will be thrown.
73
The comparison will be performed by an InterTree object looked up on
76
# Martin observes that Tree.changes_from returns a TreeDelta and this
77
# may confuse people, because the class name of the returned object is
78
# a synonym of the object referenced in the method name.
79
return InterTree.get(other, self).compare(
80
want_unchanged=want_unchanged,
81
specific_files=specific_files,
82
extra_trees=extra_trees,
83
require_versioned=require_versioned,
84
include_root=include_root
88
"""Get a list of the conflicts in the tree.
90
Each conflict is an instance of bzrlib.conflicts.Conflict.
94
def get_parent_ids(self):
95
"""Get the parent ids for this tree.
97
:return: a list of parent ids. [] is returned to indicate
98
a tree with no parents.
99
:raises: BzrError if the parents are not known.
101
raise NotImplementedError(self.get_parent_ids)
55
103
def has_filename(self, filename):
56
104
"""True if the tree has given filename."""
57
105
raise NotImplementedError()
59
107
def has_id(self, file_id):
60
108
return self.inventory.has_id(file_id)
63
"""Return set of all ids in this tree."""
64
return self.inventory.id_set()
110
__contains__ = has_id
112
def has_or_had_id(self, file_id):
113
if file_id == self.inventory.root.file_id:
115
return self.inventory.has_id(file_id)
118
return iter(self.inventory)
66
120
def id2path(self, file_id):
67
121
return self.inventory.id2path(file_id)
123
def is_control_filename(self, filename):
124
"""True if filename is the name of a control file in this tree.
126
:param filename: A filename within the tree. This is a relative path
127
from the root of this tree.
129
This is true IF and ONLY IF the filename is part of the meta data
130
that bzr controls in this tree. I.E. a random .bzr directory placed
131
on disk will not be a control file for this tree.
133
return self.bzrdir.is_control_filename(filename)
135
def iter_entries_by_dir(self):
136
"""Walk the tree in 'by_dir' order.
138
This will yield each entry in the tree as a (path, entry) tuple. The
139
order that they are yielded is: the contents of a directory are
140
preceeded by the parent of a directory, and all the contents of a
141
directory are grouped together.
143
return self.inventory.iter_entries_by_dir()
145
def kind(self, file_id):
146
raise NotImplementedError("subclasses must implement kind")
69
148
def _get_inventory(self):
70
149
return self._inventory
151
def get_file(self, file_id):
152
"""Return a file object for the file file_id in the tree."""
153
raise NotImplementedError(self.get_file)
155
def get_file_by_path(self, path):
156
return self.get_file(self._inventory.path2id(path))
72
158
inventory = property(_get_inventory,
73
159
doc="Inventory of this Tree")
75
161
def _check_retrieved(self, ie, f):
76
164
fp = fingerprint_file(f)
79
167
if ie.text_size is not None:
80
168
if ie.text_size != fp['size']:
81
bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
169
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
82
170
["inventory expects %d bytes" % ie.text_size,
83
171
"file is actually %d bytes" % fp['size'],
84
172
"store is probably damaged/corrupt"])
86
174
if ie.text_sha1 != fp['sha1']:
87
bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
175
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
88
176
["inventory expects %s" % ie.text_sha1,
89
177
"file is actually %s" % fp['sha1'],
90
178
"store is probably damaged/corrupt"])
93
def export(self, dest):
94
"""Export this tree to a new directory.
96
`dest` should not exist, and will be created holding the
97
contents of this tree.
99
:todo: To handle subdirectories we need to create the
102
:note: If the export fails, the destination directory will be
103
left in a half-assed state.
106
mutter('export version %r' % self)
108
for dp, ie in inv.iter_entries():
110
fullpath = appendpath(dest, dp)
111
if kind == 'directory':
114
pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
116
bailout("don't know how to export {%s} of kind %r", fid, kind)
117
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
121
class WorkingTree(Tree):
122
"""Working copy tree.
124
The inventory is held in the `Branch` working-inventory, and the
125
files are in a directory on disk.
127
It is possible for a `WorkingTree` to have a filename which is
128
not listed in the Inventory and vice versa.
130
def __init__(self, basedir, inv):
131
self._inventory = inv
132
self.basedir = basedir
133
self.path2id = inv.path2id
136
return "<%s of %s>" % (self.__class__.__name__,
139
def abspath(self, filename):
140
return os.path.join(self.basedir, filename)
142
def has_filename(self, filename):
143
return os.path.exists(self.abspath(filename))
145
def get_file(self, file_id):
146
return self.get_file_byname(self.id2path(file_id))
148
def get_file_byname(self, filename):
149
return file(self.abspath(filename), 'rb')
151
def _get_store_filename(self, file_id):
152
return self.abspath(self.id2path(file_id))
154
def has_id(self, file_id):
155
# files that have been deleted are excluded
156
if not self.inventory.has_id(file_id):
158
return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
160
def get_file_size(self, file_id):
161
return os.stat(self._get_store_filename(file_id))[ST_SIZE]
163
def get_file_sha1(self, file_id):
164
f = self.get_file(file_id)
168
def file_class(self, filename):
169
if self.path2id(filename):
171
elif self.is_ignored(filename):
177
def file_kind(self, filename):
178
if isfile(self.abspath(filename)):
180
elif isdir(self.abspath(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, 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, 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('', None, self.basedir):
246
def unknowns(self, path='', dir_id=None):
247
"""Yield names of unknown files in this WorkingTree.
249
If there are any unknown directories then only the directory is
250
returned, not all its children. But if there are unknown files
251
under a versioned subdirectory, they are returned.
253
Currently returned depth-first, sorted by name within directories.
255
for fpath, fclass, fkind, fid in self.list_files():
260
def ignored_files(self):
261
for fpath, fclass, fkind, fid in self.list_files():
266
def get_ignore_list(self):
267
"""Return list of ignore patterns.
269
Cached in the Tree object after the first call.
271
if hasattr(self, '_ignorelist'):
272
return self._ignorelist
274
l = bzrlib.DEFAULT_IGNORE[:]
275
if self.has_filename(bzrlib.IGNORE_FILENAME):
276
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
277
l.extend([line.rstrip("\n\r") for line in f.readlines()])
282
def is_ignored(self, filename):
283
"""Check whether the filename matches an ignore pattern.
285
Patterns containing '/' need to match the whole path; others
286
match against only the last component.
288
If the file is ignored, returns the pattern which caused it to
289
be ignored, otherwise None. So this can simply be used as a
290
boolean if desired."""
292
## TODO: Use '**' to match directories, and other extended globbing stuff from cvs/rsync.
294
for pat in self.get_ignore_list():
296
if fnmatch.fnmatchcase(filename, pat):
299
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
307
class RevisionTree(Tree):
308
"""Tree viewing a previous revision.
310
File text can be retrieved from the text store.
312
:todo: Some kind of `__repr__` method, but a good one
313
probably means knowing the branch and revision number,
314
or at least passing a description to the constructor.
317
def __init__(self, store, inv):
319
self._inventory = inv
321
def get_file(self, file_id):
322
ie = self._inventory[file_id]
323
f = self._store[ie.text_id]
324
mutter(" get fileid{%s} from %r" % (file_id, self))
325
self._check_retrieved(ie, f)
328
def get_file_size(self, file_id):
329
return self._inventory[file_id].text_size
331
def get_file_sha1(self, file_id):
332
ie = self._inventory[file_id]
335
def has_filename(self, filename):
336
return bool(self.inventory.path2id(filename))
338
def list_files(self):
339
# The only files returned by this are those from the version
340
for path, entry in self.inventory.iter_entries():
341
yield path, 'V', entry.kind, entry.file_id
180
def path2id(self, path):
181
"""Return the id for path in this tree."""
182
return self._inventory.path2id(path)
184
def print_file(self, file_id):
185
"""Print file with id `file_id` to stdout."""
187
sys.stdout.write(self.get_file_text(file_id))
193
"""What files are present in this tree and unknown.
195
:return: an iterator over the unknown files.
202
def filter_unversioned_files(self, paths):
203
"""Filter out paths that are not versioned.
205
:return: set of paths.
207
# NB: we specifically *don't* call self.has_filename, because for
208
# WorkingTrees that can indicate files that exist on disk but that
210
pred = self.inventory.has_filename
211
return set((p for p in paths if not pred(p)))
215
from bzrlib.revisiontree import RevisionTree
344
218
class EmptyTree(Tree):
345
220
def __init__(self):
346
221
self._inventory = Inventory()
222
warn('EmptyTree is deprecated as of bzr 0.9 please use '
223
'repository.revision_tree instead.',
224
DeprecationWarning, stacklevel=2)
226
def get_parent_ids(self):
229
def get_symlink_target(self, file_id):
348
232
def has_filename(self, filename):
235
def kind(self, file_id):
236
assert self._inventory[file_id].kind == "directory"
351
239
def list_files(self):
352
if False: # just to make it a generator
242
def __contains__(self, file_id):
243
return (file_id in self._inventory)
245
def get_file_sha1(self, file_id, path=None):
357
249
######################################################################
304
def find_renames(old_inv, new_inv):
305
for file_id in old_inv:
306
if file_id not in new_inv:
308
old_name = old_inv.id2path(file_id)
309
new_name = new_inv.id2path(file_id)
310
if old_name != new_name:
311
yield (old_name, new_name)
314
def find_ids_across_trees(filenames, trees, require_versioned=True):
315
"""Find the ids corresponding to specified filenames.
317
All matches in all trees will be used, and all children of matched
318
directories will be used.
320
:param filenames: The filenames to find file_ids for
321
:param trees: The trees to find file_ids within
322
:param require_versioned: if true, all specified filenames must occur in
324
:return: a set of file ids for the specified filenames and their children.
328
specified_ids = _find_filename_ids_across_trees(filenames, trees,
330
return _find_children_across_trees(specified_ids, trees)
333
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
334
"""Find the ids corresponding to specified filenames.
336
All matches in all trees will be used.
338
:param filenames: The filenames to find file_ids for
339
:param trees: The trees to find file_ids within
340
:param require_versioned: if true, all specified filenames must occur in
342
:return: a set of file ids for the specified filenames
345
interesting_ids = set()
346
for tree_path in filenames:
349
file_id = tree.inventory.path2id(tree_path)
350
if file_id is not None:
351
interesting_ids.add(file_id)
354
not_versioned.append(tree_path)
355
if len(not_versioned) > 0 and require_versioned:
356
raise errors.PathsNotVersionedError(not_versioned)
357
return interesting_ids
360
def _find_children_across_trees(specified_ids, trees):
361
"""Return a set including specified ids and their children
363
All matches in all trees will be used.
365
:param trees: The trees to find file_ids within
366
:return: a set containing all specified ids and their children
368
interesting_ids = set(specified_ids)
369
pending = interesting_ids
370
# now handle children of interesting ids
371
# we loop so that we handle all children of each id in both trees
372
while len(pending) > 0:
374
for file_id in pending:
376
if file_id not in tree:
378
entry = tree.inventory[file_id]
379
for child in getattr(entry, 'children', {}).itervalues():
380
if child.file_id not in interesting_ids:
381
new_pending.add(child.file_id)
382
interesting_ids.update(new_pending)
383
pending = new_pending
384
return interesting_ids
387
class InterTree(InterObject):
388
"""This class represents operations taking place between two Trees.
390
Its instances have methods like 'compare' and contain references to the
391
source and target trees these operations are to be carried out on.
393
clients of bzrlib should not need to use InterTree directly, rather they
394
should use the convenience methods on Tree such as 'Tree.compare()' which
395
will pass through to InterTree as appropriate.
401
def compare(self, want_unchanged=False, specific_files=None,
402
extra_trees=None, require_versioned=False, include_root=False):
403
"""Return the changes from source to target.
405
:return: A TreeDelta.
406
:param specific_files: An optional list of file paths to restrict the
407
comparison to. When mapping filenames to ids, all matches in all
408
trees (including optional extra_trees) are used, and all children of
409
matched directories are included.
410
:param want_unchanged: An optional boolean requesting the inclusion of
411
unchanged entries in the result.
412
:param extra_trees: An optional list of additional trees to use when
413
mapping the contents of specific_files (paths) to file_ids.
414
:param require_versioned: An optional boolean (defaults to False). When
415
supplied and True all the 'specific_files' must be versioned, or
416
a PathsNotVersionedError will be thrown.
418
# NB: show_status depends on being able to pass in non-versioned files and
419
# report them as unknown
420
trees = (self.source, self.target)
421
if extra_trees is not None:
422
trees = trees + tuple(extra_trees)
423
specific_file_ids = find_ids_across_trees(specific_files,
424
trees, require_versioned=require_versioned)
425
if specific_files and not specific_file_ids:
426
# All files are unversioned, so just return an empty delta
427
# _compare_trees would think we want a complete delta
428
return delta.TreeDelta()
429
return delta._compare_trees(self.source, self.target, want_unchanged,
430
specific_file_ids, include_root)
added
removed
bzrlib/tree.py
