82
69
size in bytes of the text of the file
72
the revision_id in which the text of this file was introduced
84
74
(reading a version 4 tree created a text_id field.)
86
76
>>> i = Inventory()
89
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
90
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
91
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
92
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
93
>>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
94
>>> for ix, j in enumerate(i.iter_entries()):
95
... print (j[0] == shouldbe[ix], j[1])
79
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
80
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
81
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
82
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
83
>>> for j in i.iter_entries():
97
(True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
98
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
99
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
100
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
86
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
87
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
88
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
101
89
Traceback (most recent call last):
103
91
BzrError: inventory already contains entry with id {2323}
104
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
105
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
106
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
107
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
92
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
93
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
94
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
95
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
108
96
>>> i.path2id('src/wibble')
112
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
113
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
100
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
101
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
115
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
103
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
116
104
>>> for path, entry in i.iter_entries():
105
... print path.replace('\\\\', '/') # for win32 os.sep
118
106
... assert i.path2id(path)
125
112
src/wibble/wibble.c
126
>>> i.id2path('2326')
113
>>> i.id2path('2326').replace('\\\\', '/')
127
114
'src/wibble/wibble.c'
130
# Constants returned by describe_change()
132
# TODO: These should probably move to some kind of FileChangeDescription
133
# class; that's like what's inside a TreeDelta but we want to be able to
134
# generate them just for one file at a time.
136
MODIFIED_AND_RENAMED = 'modified and renamed'
140
def detect_changes(self, old_entry):
141
"""Return a (text_modified, meta_modified) from this to old_entry.
143
_read_tree_state must have been called on self and old_entry prior to
144
calling detect_changes.
148
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
149
output_to, reverse=False):
150
"""Perform a diff from this to to_entry.
152
text_diff will be used for textual difference calculation.
153
This is a template method, override _diff in child classes.
155
self._read_tree_state(tree.id2path(self.file_id), tree)
157
# cannot diff from one kind to another - you must do a removal
158
# and an addif they do not match.
159
assert self.kind == to_entry.kind
160
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
162
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
165
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
166
output_to, reverse=False):
167
"""Perform a diff between two entries of the same kind."""
169
def find_previous_heads(self, previous_inventories,
170
versioned_file_store,
173
"""Return the revisions and entries that directly precede this.
175
Returned as a map from revision to inventory entry.
177
This is a map containing the file revisions in all parents
178
for which the file exists, and its revision is not a parent of
179
any other. If the file is new, the set will be empty.
181
:param versioned_file_store: A store where ancestry data on this
182
file id can be queried.
183
:param transaction: The transaction that queries to the versioned
184
file store should be completed under.
185
:param entry_vf: The entry versioned file, if its already available.
187
def get_ancestors(weave, entry):
188
return set(weave.get_ancestry(entry.revision))
189
# revision:ie mapping for each ie found in previous_inventories.
191
# revision:ie mapping with one revision for each head.
193
# revision: ancestor list for each head
195
# identify candidate head revision ids.
196
for inv in previous_inventories:
197
if self.file_id in inv:
198
ie = inv[self.file_id]
199
assert ie.file_id == self.file_id
200
if ie.revision in candidates:
201
# same revision value in two different inventories:
202
# correct possible inconsistencies:
203
# * there was a bug in revision updates with 'x' bit
206
if candidates[ie.revision].executable != ie.executable:
207
candidates[ie.revision].executable = False
208
ie.executable = False
209
except AttributeError:
211
# must now be the same.
212
assert candidates[ie.revision] == ie
214
# add this revision as a candidate.
215
candidates[ie.revision] = ie
217
# common case optimisation
218
if len(candidates) == 1:
219
# if there is only one candidate revision found
220
# then we can opening the versioned file to access ancestry:
221
# there cannot be any ancestors to eliminate when there is
222
# only one revision available.
223
heads[ie.revision] = ie
226
# eliminate ancestors amongst the available candidates:
227
# heads are those that are not an ancestor of any other candidate
228
# - this provides convergence at a per-file level.
229
for ie in candidates.values():
230
# may be an ancestor of a known head:
231
already_present = 0 != len(
232
[head for head in heads
233
if ie.revision in head_ancestors[head]])
235
# an ancestor of an analyzed candidate.
237
# not an ancestor of a known head:
238
# load the versioned file for this file id if needed
240
entry_vf = versioned_file_store.get_weave_or_empty(
241
self.file_id, transaction)
242
ancestors = get_ancestors(entry_vf, ie)
243
# may knock something else out:
244
check_heads = list(heads.keys())
245
for head in check_heads:
246
if head in ancestors:
247
# this previously discovered 'head' is not
248
# really a head - its an ancestor of the newly
251
head_ancestors[ie.revision] = ancestors
252
heads[ie.revision] = ie
255
def get_tar_item(self, root, dp, now, tree):
256
"""Get a tarfile item and a file stream for its content."""
257
item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
258
# TODO: would be cool to actually set it to the timestamp of the
259
# revision it was last changed
261
fileobj = self._put_in_tar(item, tree)
265
"""Return true if the object this entry represents has textual data.
267
Note that textual data includes binary content.
269
Also note that all entries get weave files created for them.
270
This attribute is primarily used when upgrading from old trees that
271
did not have the weave index for all inventory entries.
275
def __init__(self, file_id, name, parent_id, text_id=None):
117
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
118
'text_id', 'parent_id', 'children',
119
'text_version', 'name_version', ]
122
def __init__(self, file_id, name, kind, parent_id, text_id=None):
276
123
"""Create an InventoryEntry
278
125
The filename must be a single component, relative to the
279
126
parent directory; it cannot be a whole path or relative name.
281
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
128
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
286
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
133
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
287
134
Traceback (most recent call last):
288
InvalidEntryName: Invalid entry name: src/hello.c
135
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
290
137
assert isinstance(name, basestring), name
291
138
if '/' in name or '\\' in name:
292
raise errors.InvalidEntryName(name=name)
293
self.executable = False
139
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
141
self.text_version = None
142
self.name_version = None
295
143
self.text_sha1 = None
296
144
self.text_size = None
297
145
self.file_id = file_id
298
assert isinstance(file_id, (str, None.__class__)), \
299
'bad type %r for %r' % (type(file_id), file_id)
301
148
self.text_id = text_id
302
149
self.parent_id = parent_id
303
self.symlink_target = None
305
def kind_character(self):
306
"""Return a short kind indicator useful for appending to names."""
307
raise BzrError('unknown kind %r' % self.kind)
309
known_kinds = ('file', 'directory', 'symlink')
311
def _put_in_tar(self, item, tree):
312
"""populate item for stashing in a tar, and return the content stream.
314
If no content is available, return None.
316
raise BzrError("don't know how to export {%s} of kind %r" %
317
(self.file_id, self.kind))
319
def put_on_disk(self, dest, dp, tree):
320
"""Create a representation of self on disk in the prefix dest.
322
This is a template method - implement _put_on_disk in subclasses.
324
fullpath = osutils.pathjoin(dest, dp)
325
self._put_on_disk(fullpath, tree)
326
# mutter(" export {%s} kind %s to %s", self.file_id,
327
# self.kind, fullpath)
329
def _put_on_disk(self, fullpath, tree):
330
"""Put this entry onto disk at fullpath, from tree tree."""
331
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
150
if kind == 'directory':
155
raise BzrError("unhandled entry kind %r" % kind)
333
159
def sorted_children(self):
334
return sorted(self.children.items())
337
def versionable_kind(kind):
338
return (kind in ('file', 'directory', 'symlink'))
340
def check(self, checker, rev_id, inv, tree):
341
"""Check this inventory entry is intact.
343
This is a template method, override _check for kind specific
346
:param checker: Check object providing context for the checks;
347
can be used to find out what parts of the repository have already
349
:param rev_id: Revision id from which this InventoryEntry was loaded.
350
Not necessarily the last-changed revision for this file.
351
:param inv: Inventory from which the entry was loaded.
352
:param tree: RevisionTree for this entry.
354
if self.parent_id is not None:
355
if not inv.has_id(self.parent_id):
356
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
357
% (self.parent_id, rev_id))
358
self._check(checker, rev_id, tree)
360
def _check(self, checker, rev_id, tree):
361
"""Check this inventory entry for kind specific errors."""
362
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
160
l = self.children.items()
366
"""Clone this inventory entry."""
367
raise NotImplementedError
370
def describe_change(old_entry, new_entry):
371
"""Describe the change between old_entry and this.
373
This smells of being an InterInventoryEntry situation, but as its
374
the first one, we're making it a static method for now.
376
An entry with a different parent, or different name is considered
377
to be renamed. Reparenting is an internal detail.
378
Note that renaming the parent does not trigger a rename for the
381
# TODO: Perhaps return an object rather than just a string
382
if old_entry is new_entry:
383
# also the case of both being None
385
elif old_entry is None:
387
elif new_entry is None:
389
if old_entry.kind != new_entry.kind:
391
text_modified, meta_modified = new_entry.detect_changes(old_entry)
392
if text_modified or meta_modified:
396
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
397
if old_entry.parent_id != new_entry.parent_id:
399
elif old_entry.name != new_entry.name:
403
if renamed and not modified:
404
return InventoryEntry.RENAMED
405
if modified and not renamed:
407
if modified and renamed:
408
return InventoryEntry.MODIFIED_AND_RENAMED
166
other = InventoryEntry(self.file_id, self.name, self.kind,
168
other.text_id = self.text_id
169
other.text_sha1 = self.text_sha1
170
other.text_size = self.text_size
171
other.text_version = self.text_version
172
other.name_version = self.name_version
173
# note that children are *not* copied; they're pulled across when
411
178
def __repr__(self):
412
return ("%s(%r, %r, parent_id=%r, revision=%r)"
179
return ("%s(%r, %r, kind=%r, parent_id=%r)"
413
180
% (self.__class__.__name__,
419
def snapshot(self, revision, path, previous_entries,
420
work_tree, commit_builder):
421
"""Make a snapshot of this entry which may or may not have changed.
423
This means that all its fields are populated, that it has its
424
text stored in the text store or weave.
426
# mutter('new parents of %s are %r', path, previous_entries)
427
self._read_tree_state(path, work_tree)
428
# TODO: Where should we determine whether to reuse a
429
# previous revision id or create a new revision? 20060606
430
if len(previous_entries) == 1:
431
# cannot be unchanged unless there is only one parent file rev.
432
parent_ie = previous_entries.values()[0]
433
if self._unchanged(parent_ie):
434
# mutter("found unchanged entry")
435
self.revision = parent_ie.revision
437
return self._snapshot_into_revision(revision, previous_entries,
438
work_tree, commit_builder)
440
def _snapshot_into_revision(self, revision, previous_entries, work_tree,
442
"""Record this revision unconditionally into a store.
444
The entry's last-changed revision property (`revision`) is updated to
445
that of the new revision.
447
:param revision: id of the new revision that is being recorded.
449
:returns: String description of the commit (e.g. "merged", "modified"), etc.
451
# mutter('new revision {%s} for {%s}', revision, self.file_id)
452
self.revision = revision
453
self._snapshot_text(previous_entries, work_tree, commit_builder)
455
def _snapshot_text(self, file_parents, work_tree, commit_builder):
456
"""Record the 'text' of this entry, whatever form that takes.
458
This default implementation simply adds an empty text.
460
raise NotImplementedError(self._snapshot_text)
462
187
def __eq__(self, other):
463
188
if not isinstance(other, InventoryEntry):
464
189
return NotImplemented
466
return ((self.file_id == other.file_id)
467
and (self.name == other.name)
468
and (other.symlink_target == self.symlink_target)
469
and (self.text_sha1 == other.text_sha1)
470
and (self.text_size == other.text_size)
471
and (self.text_id == other.text_id)
472
and (self.parent_id == other.parent_id)
473
and (self.kind == other.kind)
474
and (self.revision == other.revision)
475
and (self.executable == other.executable)
191
return (self.file_id == other.file_id) \
192
and (self.name == other.name) \
193
and (self.text_sha1 == other.text_sha1) \
194
and (self.text_size == other.text_size) \
195
and (self.text_id == other.text_id) \
196
and (self.parent_id == other.parent_id) \
197
and (self.kind == other.kind) \
198
and (self.text_version == other.text_version) \
199
and (self.name_version == other.name_version)
478
202
def __ne__(self, other):
479
203
return not (self == other)
538
223
and (self.children == other.children)
541
class InventoryDirectory(InventoryEntry):
542
"""A directory in an inventory."""
544
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
545
'text_id', 'parent_id', 'children', 'executable',
546
'revision', 'symlink_target']
548
def _check(self, checker, rev_id, tree):
549
"""See InventoryEntry._check"""
550
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
551
raise BzrCheckError('directory {%s} has text in revision {%s}'
552
% (self.file_id, rev_id))
555
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
556
other.revision = self.revision
557
# note that children are *not* copied; they're pulled across when
561
def __init__(self, file_id, name, parent_id):
562
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
564
self.kind = 'directory'
566
def kind_character(self):
567
"""See InventoryEntry.kind_character."""
570
def _put_in_tar(self, item, tree):
571
"""See InventoryEntry._put_in_tar."""
572
item.type = tarfile.DIRTYPE
579
def _put_on_disk(self, fullpath, tree):
580
"""See InventoryEntry._put_on_disk."""
583
def _snapshot_text(self, file_parents, work_tree, commit_builder):
584
"""See InventoryEntry._snapshot_text."""
585
commit_builder.modified_directory(self.file_id, file_parents)
588
class InventoryFile(InventoryEntry):
589
"""A file in an inventory."""
591
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
592
'text_id', 'parent_id', 'children', 'executable',
593
'revision', 'symlink_target']
595
def _check(self, checker, tree_revision_id, tree):
596
"""See InventoryEntry._check"""
597
t = (self.file_id, self.revision)
598
if t in checker.checked_texts:
599
prev_sha = checker.checked_texts[t]
600
if prev_sha != self.text_sha1:
601
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
602
(self.file_id, tree_revision_id))
604
checker.repeated_text_cnt += 1
607
if self.file_id not in checker.checked_weaves:
608
mutter('check weave {%s}', self.file_id)
609
w = tree.get_weave(self.file_id)
610
# Not passing a progress bar, because it creates a new
611
# progress, which overwrites the current progress,
612
# and doesn't look nice
614
checker.checked_weaves[self.file_id] = True
616
w = tree.get_weave(self.file_id)
618
mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
619
checker.checked_text_cnt += 1
620
# We can't check the length, because Weave doesn't store that
621
# information, and the whole point of looking at the weave's
622
# sha1sum is that we don't have to extract the text.
623
if self.text_sha1 != w.get_sha1(self.revision):
624
raise BzrCheckError('text {%s} version {%s} wrong sha1'
625
% (self.file_id, self.revision))
626
checker.checked_texts[t] = self.text_sha1
629
other = InventoryFile(self.file_id, self.name, self.parent_id)
630
other.executable = self.executable
631
other.text_id = self.text_id
632
other.text_sha1 = self.text_sha1
633
other.text_size = self.text_size
634
other.revision = self.revision
637
def detect_changes(self, old_entry):
638
"""See InventoryEntry.detect_changes."""
639
assert self.text_sha1 is not None
640
assert old_entry.text_sha1 is not None
641
text_modified = (self.text_sha1 != old_entry.text_sha1)
642
meta_modified = (self.executable != old_entry.executable)
643
return text_modified, meta_modified
645
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
646
output_to, reverse=False):
647
"""See InventoryEntry._diff."""
649
from_text = tree.get_file(self.file_id).readlines()
651
to_text = to_tree.get_file(to_entry.file_id).readlines()
655
text_diff(from_label, from_text,
656
to_label, to_text, output_to)
658
text_diff(to_label, to_text,
659
from_label, from_text, output_to)
660
except errors.BinaryFile:
662
label_pair = (to_label, from_label)
664
label_pair = (from_label, to_label)
665
print >> output_to, "Binary files %s and %s differ" % label_pair
668
"""See InventoryEntry.has_text."""
671
def __init__(self, file_id, name, parent_id):
672
super(InventoryFile, self).__init__(file_id, name, parent_id)
675
def kind_character(self):
676
"""See InventoryEntry.kind_character."""
679
def _put_in_tar(self, item, tree):
680
"""See InventoryEntry._put_in_tar."""
681
item.type = tarfile.REGTYPE
682
fileobj = tree.get_file(self.file_id)
683
item.size = self.text_size
684
if tree.is_executable(self.file_id):
690
def _put_on_disk(self, fullpath, tree):
691
"""See InventoryEntry._put_on_disk."""
692
osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
693
if tree.is_executable(self.file_id):
694
os.chmod(fullpath, 0755)
696
def _read_tree_state(self, path, work_tree):
697
"""See InventoryEntry._read_tree_state."""
698
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
699
# FIXME: 20050930 probe for the text size when getting sha1
700
# in _read_tree_state
701
self.executable = work_tree.is_executable(self.file_id, path=path)
704
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
705
% (self.__class__.__name__,
712
def _forget_tree_state(self):
713
self.text_sha1 = None
715
def _snapshot_text(self, file_parents, work_tree, commit_builder):
716
"""See InventoryEntry._snapshot_text."""
717
def get_content_byte_lines():
718
return work_tree.get_file(self.file_id).readlines()
719
self.text_sha1, self.text_size = commit_builder.modified_file_text(
720
self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
722
def _unchanged(self, previous_ie):
723
"""See InventoryEntry._unchanged."""
724
compatible = super(InventoryFile, self)._unchanged(previous_ie)
725
if self.text_sha1 != previous_ie.text_sha1:
728
# FIXME: 20050930 probe for the text size when getting sha1
729
# in _read_tree_state
730
self.text_size = previous_ie.text_size
731
if self.executable != previous_ie.executable:
736
class InventoryLink(InventoryEntry):
737
"""A file in an inventory."""
739
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
740
'text_id', 'parent_id', 'children', 'executable',
741
'revision', 'symlink_target']
743
def _check(self, checker, rev_id, tree):
744
"""See InventoryEntry._check"""
745
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
746
raise BzrCheckError('symlink {%s} has text in revision {%s}'
747
% (self.file_id, rev_id))
748
if self.symlink_target is None:
749
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
750
% (self.file_id, rev_id))
753
other = InventoryLink(self.file_id, self.name, self.parent_id)
754
other.symlink_target = self.symlink_target
755
other.revision = self.revision
758
def detect_changes(self, old_entry):
759
"""See InventoryEntry.detect_changes."""
760
# FIXME: which _modified field should we use ? RBC 20051003
761
text_modified = (self.symlink_target != old_entry.symlink_target)
763
mutter(" symlink target changed")
764
meta_modified = False
765
return text_modified, meta_modified
767
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
768
output_to, reverse=False):
769
"""See InventoryEntry._diff."""
770
from_text = self.symlink_target
771
if to_entry is not None:
772
to_text = to_entry.symlink_target
777
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
780
print >>output_to, '=== target was %r' % self.symlink_target
782
print >>output_to, '=== target is %r' % self.symlink_target
784
def __init__(self, file_id, name, parent_id):
785
super(InventoryLink, self).__init__(file_id, name, parent_id)
786
self.kind = 'symlink'
788
def kind_character(self):
789
"""See InventoryEntry.kind_character."""
792
def _put_in_tar(self, item, tree):
793
"""See InventoryEntry._put_in_tar."""
794
item.type = tarfile.SYMTYPE
798
item.linkname = self.symlink_target
801
def _put_on_disk(self, fullpath, tree):
802
"""See InventoryEntry._put_on_disk."""
804
os.symlink(self.symlink_target, fullpath)
806
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
808
def _read_tree_state(self, path, work_tree):
809
"""See InventoryEntry._read_tree_state."""
810
self.symlink_target = work_tree.get_symlink_target(self.file_id)
812
def _forget_tree_state(self):
813
self.symlink_target = None
815
def _unchanged(self, previous_ie):
816
"""See InventoryEntry._unchanged."""
817
compatible = super(InventoryLink, self)._unchanged(previous_ie)
818
if self.symlink_target != previous_ie.symlink_target:
822
def _snapshot_text(self, file_parents, work_tree, commit_builder):
823
"""See InventoryEntry._snapshot_text."""
824
commit_builder.modified_link(
825
self.file_id, file_parents, self.symlink_target)
828
227
class Inventory(object):
829
228
"""Inventory of versioned files in a tree.
876
272
The inventory is created with a default root directory, with
879
if root_id is not None:
880
assert root_id.__class__ == str
881
self._set_root(InventoryDirectory(root_id, u'', None))
885
self.revision_id = revision_id
887
def _set_root(self, ie):
275
# We are letting Branch.initialize() create a unique inventory
276
# root id. Rather than generating a random one here.
278
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
279
self.root = RootEntry(root_id)
889
280
self._byid = {self.root.file_id: self.root}
892
# TODO: jam 20051218 Should copy also copy the revision_id?
893
entries = self.iter_entries()
894
other = Inventory(entries.next()[1].file_id)
284
other = Inventory(self.root.file_id)
895
285
# copy recursively so we know directories will be added before
896
286
# their children. There are more efficient ways than this...
897
for path, entry in entries():
287
for path, entry in self.iter_entries():
288
if entry == self.root:
898
290
other.add(entry.copy())
901
294
def __iter__(self):
902
295
return iter(self._byid)
904
298
def __len__(self):
905
299
"""Returns number of entries."""
906
300
return len(self._byid)
908
303
def iter_entries(self, from_dir=None):
909
304
"""Return (path, entry) pairs, in order by name."""
911
if self.root is None:
915
elif isinstance(from_dir, basestring):
916
from_dir = self._byid[from_dir]
918
# unrolling the recursive called changed the time from
919
# 440ms/663ms (inline/total) to 116ms/116ms
920
children = from_dir.children.items()
922
children = collections.deque(children)
923
stack = [(u'', children)]
925
from_dir_relpath, children = stack[-1]
928
name, ie = children.popleft()
930
# we know that from_dir_relpath never ends in a slash
931
# and 'f' doesn't begin with one, we can do a string op, rather
932
# than the checks of pathjoin(), though this means that all paths
934
path = from_dir_relpath + '/' + name
938
if ie.kind != 'directory':
941
# But do this child first
942
new_children = ie.children.items()
944
new_children = collections.deque(new_children)
945
stack.append((path, new_children))
946
# Break out of inner loop, so that we start outer loop with child
949
# if we finished all children, pop it off the stack
952
def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None):
953
"""Iterate over the entries in a directory first order.
955
This returns all entries for a directory before returning
956
the entries for children of a directory. This is not
957
lexicographically sorted order, and is a hybrid between
958
depth-first and breadth-first.
960
:return: This yields (path, entry) pairs
962
if specific_file_ids:
963
specific_file_ids = [osutils.safe_file_id(fid)
964
for fid in specific_file_ids]
965
# TODO? Perhaps this should return the from_dir so that the root is
966
# yielded? or maybe an option?
968
if self.root is None:
970
# Optimize a common case
971
if specific_file_ids is not None and len(specific_file_ids) == 1:
972
file_id = list(specific_file_ids)[0]
974
yield self.id2path(file_id), self[file_id]
977
if (specific_file_ids is None or
978
self.root.file_id in specific_file_ids):
980
elif isinstance(from_dir, basestring):
981
from_dir = self._byid[from_dir]
983
if specific_file_ids is not None:
985
def add_ancestors(file_id):
986
if file_id not in self:
988
parent_id = self[file_id].parent_id
989
if parent_id is None:
991
if parent_id not in parents:
992
parents.add(parent_id)
993
add_ancestors(parent_id)
994
for file_id in specific_file_ids:
995
add_ancestors(file_id)
999
stack = [(u'', from_dir)]
1001
cur_relpath, cur_dir = stack.pop()
1004
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
1006
child_relpath = cur_relpath + child_name
1008
if (specific_file_ids is None or
1009
child_ie.file_id in specific_file_ids):
1010
yield child_relpath, child_ie
1012
if child_ie.kind == 'directory':
1013
if parents is None or child_ie.file_id in parents:
1014
child_dirs.append((child_relpath+'/', child_ie))
1015
stack.extend(reversed(child_dirs))
308
elif isinstance(from_dir, basestring):
309
from_dir = self._byid[from_dir]
311
kids = from_dir.children.items()
313
for name, ie in kids:
315
if ie.kind == 'directory':
316
for cn, cie in self.iter_entries(from_dir=ie.file_id):
317
yield os.path.join(name, cn), cie
1017
320
def entries(self):
1018
321
"""Return list of (path, ie) for all entries except the root.
added
removed
bzrlib/inventory.py
