36
60
An InventoryEntry has the following fields, which are also
37
61
present in the XML inventory-entry element:
40
* *name*: (only the basename within the directory, must not
42
* *kind*: "directory" or "file"
43
* *directory_id*: (if absent/null means the branch root directory)
44
* *text_sha1*: only for files
45
* *text_size*: in bytes, only for files
46
* *text_id*: identifier for the text version, only for files
48
InventoryEntries can also exist inside a WorkingTree
49
inventory, in which case they are not yet bound to a
50
particular revision of the file. In that case the text_sha1,
51
text_size and text_id are absent.
66
(within the parent directory)
69
file_id of the parent directory, or ROOT_ID
72
the revision_id in which this variation of this file was
76
Indicates that this file should be executable on systems
80
sha-1 of the text of the file
83
size in bytes of the text of the file
85
(reading a version 4 tree created a text_id field.)
54
87
>>> i = Inventory()
57
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
58
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
59
>>> for j in i.iter_entries():
62
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
63
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
64
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
65
Traceback (most recent call last):
90
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
91
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
92
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
93
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
94
>>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
95
>>> for ix, j in enumerate(i.iter_entries()):
96
... print (j[0] == shouldbe[ix], j[1])
67
BzrError: inventory already contains entry with id {2323}
68
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
69
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
98
(True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
99
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
100
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
101
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
102
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
103
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
104
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
70
105
>>> i.path2id('src/wibble')
74
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
109
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
110
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
76
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
77
>>> for j in i.iter_entries():
79
... assert i.path2id(j[0])
112
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
113
>>> for path, entry in i.iter_entries():
85
121
src/wibble/wibble.c
86
122
>>> i.id2path('2326')
87
123
'src/wibble/wibble.c'
89
TODO: Maybe also keep the full path of the entry, and the children?
90
But those depend on its position within a particular inventory, and
91
it would be nice not to need to hold the backpointer here.
94
# TODO: split InventoryEntry into subclasses for files,
95
# directories, etc etc.
97
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
'text_id', 'parent_id', 'children', ]
100
def __init__(self, file_id, name, kind, parent_id, text_id=None):
126
# Constants returned by describe_change()
128
# TODO: These should probably move to some kind of FileChangeDescription
129
# class; that's like what's inside a TreeDelta but we want to be able to
130
# generate them just for one file at a time.
132
MODIFIED_AND_RENAMED = 'modified and renamed'
136
def detect_changes(self, old_entry):
137
"""Return a (text_modified, meta_modified) from this to old_entry.
139
_read_tree_state must have been called on self and old_entry prior to
140
calling detect_changes.
144
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
145
output_to, reverse=False):
146
"""Perform a diff between two entries of the same kind."""
148
def parent_candidates(self, previous_inventories):
149
"""Find possible per-file graph parents.
151
This is currently defined by:
152
- Select the last changed revision in the parent inventory.
153
- Do deal with a short lived bug in bzr 0.8's development two entries
154
that have the same last changed but different 'x' bit settings are
157
# revision:ie mapping for each ie found in previous_inventories.
159
# identify candidate head revision ids.
160
for inv in previous_inventories:
161
if self.file_id in inv:
162
ie = inv[self.file_id]
163
if ie.revision in candidates:
164
# same revision value in two different inventories:
165
# correct possible inconsistencies:
166
# * there was a bug in revision updates with 'x' bit
169
if candidates[ie.revision].executable != ie.executable:
170
candidates[ie.revision].executable = False
171
ie.executable = False
172
except AttributeError:
175
# add this revision as a candidate.
176
candidates[ie.revision] = ie
179
@deprecated_method(deprecated_in((1, 6, 0)))
180
def get_tar_item(self, root, dp, now, tree):
181
"""Get a tarfile item and a file stream for its content."""
182
item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
183
# TODO: would be cool to actually set it to the timestamp of the
184
# revision it was last changed
186
fileobj = self._put_in_tar(item, tree)
190
"""Return true if the object this entry represents has textual data.
192
Note that textual data includes binary content.
194
Also note that all entries get weave files created for them.
195
This attribute is primarily used when upgrading from old trees that
196
did not have the weave index for all inventory entries.
200
def __init__(self, file_id, name, parent_id, text_id=None):
101
201
"""Create an InventoryEntry
103
203
The filename must be a single component, relative to the
104
204
parent directory; it cannot be a whole path or relative name.
106
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
206
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
111
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
211
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
112
212
Traceback (most recent call last):
113
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
213
InvalidEntryName: Invalid entry name: src/hello.c
115
215
if '/' in name or '\\' in name:
116
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
216
raise errors.InvalidEntryName(name=name)
217
self.executable = False
118
219
self.text_sha1 = None
119
220
self.text_size = None
121
221
self.file_id = file_id
124
223
self.text_id = text_id
125
224
self.parent_id = parent_id
126
if kind == 'directory':
131
raise BzrError("unhandled entry kind %r" % kind)
225
self.symlink_target = None
226
self.reference_revision = None
228
def kind_character(self):
229
"""Return a short kind indicator useful for appending to names."""
230
raise BzrError('unknown kind %r' % self.kind)
232
known_kinds = ('file', 'directory', 'symlink')
234
def _put_in_tar(self, item, tree):
235
"""populate item for stashing in a tar, and return the content stream.
237
If no content is available, return None.
239
raise BzrError("don't know how to export {%s} of kind %r" %
240
(self.file_id, self.kind))
242
@deprecated_method(deprecated_in((1, 6, 0)))
243
def put_on_disk(self, dest, dp, tree):
244
"""Create a representation of self on disk in the prefix dest.
246
This is a template method - implement _put_on_disk in subclasses.
248
fullpath = osutils.pathjoin(dest, dp)
249
self._put_on_disk(fullpath, tree)
250
# mutter(" export {%s} kind %s to %s", self.file_id,
251
# self.kind, fullpath)
253
def _put_on_disk(self, fullpath, tree):
254
"""Put this entry onto disk at fullpath, from tree tree."""
255
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
135
257
def sorted_children(self):
136
l = self.children.items()
258
return sorted(self.children.items())
261
def versionable_kind(kind):
262
return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
264
def check(self, checker, rev_id, inv, tree):
265
"""Check this inventory entry is intact.
267
This is a template method, override _check for kind specific
270
:param checker: Check object providing context for the checks;
271
can be used to find out what parts of the repository have already
273
:param rev_id: Revision id from which this InventoryEntry was loaded.
274
Not necessarily the last-changed revision for this file.
275
:param inv: Inventory from which the entry was loaded.
276
:param tree: RevisionTree for this entry.
278
if self.parent_id is not None:
279
if not inv.has_id(self.parent_id):
280
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
281
% (self.parent_id, rev_id))
282
self._check(checker, rev_id, tree)
284
def _check(self, checker, rev_id, tree):
285
"""Check this inventory entry for kind specific errors."""
286
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
142
other = InventoryEntry(self.file_id, self.name, self.kind,
143
self.parent_id, text_id=self.text_id)
144
other.text_sha1 = self.text_sha1
145
other.text_size = self.text_size
146
# note that children are *not* copied; they're pulled across when
290
"""Clone this inventory entry."""
291
raise NotImplementedError
294
def describe_change(old_entry, new_entry):
295
"""Describe the change between old_entry and this.
297
This smells of being an InterInventoryEntry situation, but as its
298
the first one, we're making it a static method for now.
300
An entry with a different parent, or different name is considered
301
to be renamed. Reparenting is an internal detail.
302
Note that renaming the parent does not trigger a rename for the
305
# TODO: Perhaps return an object rather than just a string
306
if old_entry is new_entry:
307
# also the case of both being None
309
elif old_entry is None:
311
elif new_entry is None:
313
if old_entry.kind != new_entry.kind:
315
text_modified, meta_modified = new_entry.detect_changes(old_entry)
316
if text_modified or meta_modified:
320
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
321
if old_entry.parent_id != new_entry.parent_id:
323
elif old_entry.name != new_entry.name:
327
if renamed and not modified:
328
return InventoryEntry.RENAMED
329
if modified and not renamed:
331
if modified and renamed:
332
return InventoryEntry.MODIFIED_AND_RENAMED
151
335
def __repr__(self):
152
return ("%s(%r, %r, kind=%r, parent_id=%r)"
336
return ("%s(%r, %r, parent_id=%r, revision=%r)"
153
337
% (self.__class__.__name__,
160
def to_element(self):
161
"""Convert to XML element"""
162
from bzrlib.xml import Element
166
e.set('name', self.name)
167
e.set('file_id', self.file_id)
168
e.set('kind', self.kind)
170
if self.text_size != None:
171
e.set('text_size', '%d' % self.text_size)
173
for f in ['text_id', 'text_sha1']:
178
# to be conservative, we don't externalize the root pointers
179
# for now, leaving them as null in the xml form. in a future
180
# version it will be implied by nested elements.
181
if self.parent_id != ROOT_ID:
182
assert isinstance(self.parent_id, basestring)
183
e.set('parent_id', self.parent_id)
190
def from_element(cls, elt):
191
assert elt.tag == 'entry'
193
## original format inventories don't have a parent_id for
194
## nodes in the root directory, but it's cleaner to use one
196
parent_id = elt.get('parent_id')
197
if parent_id == None:
200
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
201
self.text_id = elt.get('text_id')
202
self.text_sha1 = elt.get('text_sha1')
204
## mutter("read inventoryentry: %r" % (elt.attrib))
206
v = elt.get('text_size')
207
self.text_size = v and int(v)
212
from_element = classmethod(from_element)
214
343
def __eq__(self, other):
345
# For the case when objects are cached
215
347
if not isinstance(other, InventoryEntry):
216
348
return NotImplemented
218
return (self.file_id == other.file_id) \
219
and (self.name == other.name) \
220
and (self.text_sha1 == other.text_sha1) \
221
and (self.text_size == other.text_size) \
222
and (self.text_id == other.text_id) \
223
and (self.parent_id == other.parent_id) \
224
and (self.kind == other.kind)
350
return ((self.file_id == other.file_id)
351
and (self.name == other.name)
352
and (other.symlink_target == self.symlink_target)
353
and (self.text_sha1 == other.text_sha1)
354
and (self.text_size == other.text_size)
355
and (self.text_id == other.text_id)
356
and (self.parent_id == other.parent_id)
357
and (self.kind == other.kind)
358
and (self.revision == other.revision)
359
and (self.executable == other.executable)
360
and (self.reference_revision == other.reference_revision)
227
363
def __ne__(self, other):
228
364
return not (self == other)
230
366
def __hash__(self):
231
367
raise ValueError('not hashable')
369
def _unchanged(self, previous_ie):
370
"""Has this entry changed relative to previous_ie.
372
This method should be overridden in child classes.
375
# different inv parent
376
if previous_ie.parent_id != self.parent_id:
379
elif previous_ie.name != self.name:
381
elif previous_ie.kind != self.kind:
385
def _read_tree_state(self, path, work_tree):
386
"""Populate fields in the inventory entry from the given tree.
388
Note that this should be modified to be a noop on virtual trees
389
as all entries created there are prepopulated.
391
# TODO: Rather than running this manually, we should check the
392
# working sha1 and other expensive properties when they're
393
# first requested, or preload them if they're already known
394
pass # nothing to do by default
396
def _forget_tree_state(self):
235
400
class RootEntry(InventoryEntry):
402
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
403
'text_id', 'parent_id', 'children', 'executable',
404
'revision', 'symlink_target', 'reference_revision']
406
def _check(self, checker, rev_id, tree):
407
"""See InventoryEntry._check"""
236
409
def __init__(self, file_id):
237
410
self.file_id = file_id
238
411
self.children = {}
239
self.kind = 'root_directory'
412
self.kind = 'directory'
240
413
self.parent_id = None
416
symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
417
' Please use InventoryDirectory instead.',
418
DeprecationWarning, stacklevel=2)
243
420
def __eq__(self, other):
244
421
if not isinstance(other, RootEntry):
245
422
return NotImplemented
247
424
return (self.file_id == other.file_id) \
248
425
and (self.children == other.children)
428
class InventoryDirectory(InventoryEntry):
429
"""A directory in an inventory."""
431
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
432
'text_id', 'parent_id', 'children', 'executable',
433
'revision', 'symlink_target', 'reference_revision']
435
def _check(self, checker, rev_id, tree):
436
"""See InventoryEntry._check"""
437
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
438
raise BzrCheckError('directory {%s} has text in revision {%s}'
439
% (self.file_id, rev_id))
442
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
443
other.revision = self.revision
444
# note that children are *not* copied; they're pulled across when
448
def __init__(self, file_id, name, parent_id):
449
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
451
self.kind = 'directory'
453
def kind_character(self):
454
"""See InventoryEntry.kind_character."""
457
def _put_in_tar(self, item, tree):
458
"""See InventoryEntry._put_in_tar."""
459
item.type = tarfile.DIRTYPE
466
def _put_on_disk(self, fullpath, tree):
467
"""See InventoryEntry._put_on_disk."""
471
class InventoryFile(InventoryEntry):
472
"""A file in an inventory."""
474
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
475
'text_id', 'parent_id', 'children', 'executable',
476
'revision', 'symlink_target', 'reference_revision']
478
def _check(self, checker, tree_revision_id, tree):
479
"""See InventoryEntry._check"""
480
key = (self.file_id, self.revision)
481
if key in checker.checked_texts:
482
prev_sha = checker.checked_texts[key]
483
if prev_sha != self.text_sha1:
485
'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
486
(self.file_id, tree_revision_id, prev_sha, self.text_sha1,
489
checker.repeated_text_cnt += 1
492
checker.checked_text_cnt += 1
493
# We can't check the length, because Weave doesn't store that
494
# information, and the whole point of looking at the weave's
495
# sha1sum is that we don't have to extract the text.
496
if (self.text_sha1 != tree._repository.texts.get_sha1s([key])[key]):
497
raise BzrCheckError('text {%s} version {%s} wrong sha1' % key)
498
checker.checked_texts[key] = self.text_sha1
501
other = InventoryFile(self.file_id, self.name, self.parent_id)
502
other.executable = self.executable
503
other.text_id = self.text_id
504
other.text_sha1 = self.text_sha1
505
other.text_size = self.text_size
506
other.revision = self.revision
509
def detect_changes(self, old_entry):
510
"""See InventoryEntry.detect_changes."""
511
text_modified = (self.text_sha1 != old_entry.text_sha1)
512
meta_modified = (self.executable != old_entry.executable)
513
return text_modified, meta_modified
515
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
516
output_to, reverse=False):
517
"""See InventoryEntry._diff."""
518
from bzrlib.diff import DiffText
519
from_file_id = self.file_id
521
to_file_id = to_entry.file_id
525
to_file_id, from_file_id = from_file_id, to_file_id
526
tree, to_tree = to_tree, tree
527
from_label, to_label = to_label, from_label
528
differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
530
return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
533
"""See InventoryEntry.has_text."""
536
def __init__(self, file_id, name, parent_id):
537
super(InventoryFile, self).__init__(file_id, name, parent_id)
540
def kind_character(self):
541
"""See InventoryEntry.kind_character."""
544
def _put_in_tar(self, item, tree):
545
"""See InventoryEntry._put_in_tar."""
546
item.type = tarfile.REGTYPE
547
fileobj = tree.get_file(self.file_id)
548
item.size = self.text_size
549
if tree.is_executable(self.file_id):
555
def _put_on_disk(self, fullpath, tree):
556
"""See InventoryEntry._put_on_disk."""
557
osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
558
if tree.is_executable(self.file_id):
559
os.chmod(fullpath, 0755)
561
def _read_tree_state(self, path, work_tree):
562
"""See InventoryEntry._read_tree_state."""
563
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
564
# FIXME: 20050930 probe for the text size when getting sha1
565
# in _read_tree_state
566
self.executable = work_tree.is_executable(self.file_id, path=path)
569
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
570
% (self.__class__.__name__,
577
def _forget_tree_state(self):
578
self.text_sha1 = None
580
def _unchanged(self, previous_ie):
581
"""See InventoryEntry._unchanged."""
582
compatible = super(InventoryFile, self)._unchanged(previous_ie)
583
if self.text_sha1 != previous_ie.text_sha1:
586
# FIXME: 20050930 probe for the text size when getting sha1
587
# in _read_tree_state
588
self.text_size = previous_ie.text_size
589
if self.executable != previous_ie.executable:
594
class InventoryLink(InventoryEntry):
595
"""A file in an inventory."""
597
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
598
'text_id', 'parent_id', 'children', 'executable',
599
'revision', 'symlink_target', 'reference_revision']
601
def _check(self, checker, rev_id, tree):
602
"""See InventoryEntry._check"""
603
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
604
raise BzrCheckError('symlink {%s} has text in revision {%s}'
605
% (self.file_id, rev_id))
606
if self.symlink_target is None:
607
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
608
% (self.file_id, rev_id))
611
other = InventoryLink(self.file_id, self.name, self.parent_id)
612
other.symlink_target = self.symlink_target
613
other.revision = self.revision
616
def detect_changes(self, old_entry):
617
"""See InventoryEntry.detect_changes."""
618
# FIXME: which _modified field should we use ? RBC 20051003
619
text_modified = (self.symlink_target != old_entry.symlink_target)
621
mutter(" symlink target changed")
622
meta_modified = False
623
return text_modified, meta_modified
625
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
626
output_to, reverse=False):
627
"""See InventoryEntry._diff."""
628
from bzrlib.diff import DiffSymlink
629
old_target = self.symlink_target
630
if to_entry is not None:
631
new_target = to_entry.symlink_target
640
new_target, old_target = old_target, new_target
641
differ = DiffSymlink(old_tree, new_tree, output_to)
642
return differ.diff_symlink(old_target, new_target)
644
def __init__(self, file_id, name, parent_id):
645
super(InventoryLink, self).__init__(file_id, name, parent_id)
646
self.kind = 'symlink'
648
def kind_character(self):
649
"""See InventoryEntry.kind_character."""
652
def _put_in_tar(self, item, tree):
653
"""See InventoryEntry._put_in_tar."""
654
item.type = tarfile.SYMTYPE
658
item.linkname = self.symlink_target
661
def _put_on_disk(self, fullpath, tree):
662
"""See InventoryEntry._put_on_disk."""
664
os.symlink(self.symlink_target, fullpath)
666
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
668
def _read_tree_state(self, path, work_tree):
669
"""See InventoryEntry._read_tree_state."""
670
self.symlink_target = work_tree.get_symlink_target(self.file_id)
672
def _forget_tree_state(self):
673
self.symlink_target = None
675
def _unchanged(self, previous_ie):
676
"""See InventoryEntry._unchanged."""
677
compatible = super(InventoryLink, self)._unchanged(previous_ie)
678
if self.symlink_target != previous_ie.symlink_target:
683
class TreeReference(InventoryEntry):
685
kind = 'tree-reference'
687
def __init__(self, file_id, name, parent_id, revision=None,
688
reference_revision=None):
689
InventoryEntry.__init__(self, file_id, name, parent_id)
690
self.revision = revision
691
self.reference_revision = reference_revision
694
return TreeReference(self.file_id, self.name, self.parent_id,
695
self.revision, self.reference_revision)
697
def _read_tree_state(self, path, work_tree):
698
"""Populate fields in the inventory entry from the given tree.
700
self.reference_revision = work_tree.get_reference_revision(
703
def _forget_tree_state(self):
704
self.reference_revision = None
706
def _unchanged(self, previous_ie):
707
"""See InventoryEntry._unchanged."""
708
compatible = super(TreeReference, self)._unchanged(previous_ie)
709
if self.reference_revision != previous_ie.reference_revision:
252
714
class Inventory(object):
253
715
"""Inventory of versioned files in a tree.
295
762
The inventory is created with a default root directory, with
298
# We are letting Branch(init=True) create a unique inventory
299
# root id. Rather than generating a random one here.
301
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
302
self.root = RootEntry(root_id)
765
if root_id is not None:
766
self._set_root(InventoryDirectory(root_id, u'', None))
770
self.revision_id = revision_id
773
# More than one page of ouput is not useful anymore to debug
776
contents = repr(self._byid)
777
if len(contents) > max_len:
778
contents = contents[:(max_len-len(closing))] + closing
779
return "<Inventory object at %x, contents=%r>" % (id(self), contents)
781
def apply_delta(self, delta):
782
"""Apply a delta to this inventory.
784
:param delta: A list of changes to apply. After all the changes are
785
applied the final inventory must be internally consistent, but it
786
is ok to supply changes which, if only half-applied would have an
787
invalid result - such as supplying two changes which rename two
788
files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
789
('B', 'A', 'B-id', b_entry)].
791
Each change is a tuple, of the form (old_path, new_path, file_id,
794
When new_path is None, the change indicates the removal of an entry
795
from the inventory and new_entry will be ignored (using None is
796
appropriate). If new_path is not None, then new_entry must be an
797
InventoryEntry instance, which will be incorporated into the
798
inventory (and replace any existing entry with the same file id).
800
When old_path is None, the change indicates the addition of
801
a new entry to the inventory.
803
When neither new_path nor old_path are None, the change is a
804
modification to an entry, such as a rename, reparent, kind change
807
The children attribute of new_entry is ignored. This is because
808
this method preserves children automatically across alterations to
809
the parent of the children, and cases where the parent id of a
810
child is changing require the child to be passed in as a separate
811
change regardless. E.g. in the recursive deletion of a directory -
812
the directory's children must be included in the delta, or the
813
final inventory will be invalid.
815
Note that a file_id must only appear once within a given delta.
816
An AssertionError is raised otherwise.
818
# Check that the delta is legal. It would be nice if this could be
819
# done within the loops below but it's safer to validate the delta
820
# before starting to mutate the inventory.
821
unique_file_ids = set([f for _, _, f, _ in delta])
822
if len(unique_file_ids) != len(delta):
823
raise AssertionError("a file-id appears multiple times in %r"
828
# Remove all affected items which were in the original inventory,
829
# starting with the longest paths, thus ensuring parents are examined
830
# after their children, which means that everything we examine has no
831
# modified children remaining by the time we examine it.
832
for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
833
if op is not None), reverse=True):
834
if file_id not in self:
837
# Preserve unaltered children of file_id for later reinsertion.
838
file_id_children = getattr(self[file_id], 'children', {})
839
if len(file_id_children):
840
children[file_id] = file_id_children
841
# Remove file_id and the unaltered children. If file_id is not
842
# being deleted it will be reinserted back later.
843
self.remove_recursive_id(file_id)
844
# Insert all affected which should be in the new inventory, reattaching
845
# their children if they had any. This is done from shortest path to
846
# longest, ensuring that items which were modified and whose parents in
847
# the resulting inventory were also modified, are inserted after their
849
for new_path, new_entry in sorted((np, e) for op, np, f, e in
850
delta if np is not None):
851
if new_entry.kind == 'directory':
852
# Pop the child which to allow detection of children whose
853
# parents were deleted and which were not reattached to a new
855
new_entry.children = children.pop(new_entry.file_id, {})
858
# Get the parent id that was deleted
859
parent_id, children = children.popitem()
860
raise errors.InconsistentDelta("<deleted>", parent_id,
861
"The file id was deleted but its children were not deleted.")
863
def _set_root(self, ie):
303
865
self._byid = {self.root.file_id: self.root}
868
# TODO: jam 20051218 Should copy also copy the revision_id?
869
entries = self.iter_entries()
870
if self.root is None:
871
return Inventory(root_id=None)
872
other = Inventory(entries.next()[1].file_id)
873
other.root.revision = self.root.revision
874
# copy recursively so we know directories will be added before
875
# their children. There are more efficient ways than this...
876
for path, entry in entries:
877
other.add(entry.copy())
306
880
def __iter__(self):
307
881
return iter(self._byid)
310
883
def __len__(self):
311
884
"""Returns number of entries."""
312
885
return len(self._byid)
315
887
def iter_entries(self, from_dir=None):
316
888
"""Return (path, entry) pairs, in order by name."""
320
elif isinstance(from_dir, basestring):
321
from_dir = self._byid[from_dir]
323
kids = from_dir.children.items()
325
for name, ie in kids:
327
if ie.kind == 'directory':
328
for cn, cie in self.iter_entries(from_dir=ie.file_id):
329
yield os.path.join(name, cn), cie
890
if self.root is None:
894
elif isinstance(from_dir, basestring):
895
from_dir = self._byid[from_dir]
897
# unrolling the recursive called changed the time from
898
# 440ms/663ms (inline/total) to 116ms/116ms
899
children = from_dir.children.items()
901
children = collections.deque(children)
902
stack = [(u'', children)]
904
from_dir_relpath, children = stack[-1]
907
name, ie = children.popleft()
909
# we know that from_dir_relpath never ends in a slash
910
# and 'f' doesn't begin with one, we can do a string op, rather
911
# than the checks of pathjoin(), though this means that all paths
913
path = from_dir_relpath + '/' + name
917
if ie.kind != 'directory':
920
# But do this child first
921
new_children = ie.children.items()
923
new_children = collections.deque(new_children)
924
stack.append((path, new_children))
925
# Break out of inner loop, so that we start outer loop with child
928
# if we finished all children, pop it off the stack
931
def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
932
yield_parents=False):
933
"""Iterate over the entries in a directory first order.
935
This returns all entries for a directory before returning
936
the entries for children of a directory. This is not
937
lexicographically sorted order, and is a hybrid between
938
depth-first and breadth-first.
940
:param yield_parents: If True, yield the parents from the root leading
941
down to specific_file_ids that have been requested. This has no
942
impact if specific_file_ids is None.
943
:return: This yields (path, entry) pairs
945
if specific_file_ids and not isinstance(specific_file_ids, set):
946
specific_file_ids = set(specific_file_ids)
947
# TODO? Perhaps this should return the from_dir so that the root is
948
# yielded? or maybe an option?
950
if self.root is None:
952
# Optimize a common case
953
if (not yield_parents and specific_file_ids is not None and
954
len(specific_file_ids) == 1):
955
file_id = list(specific_file_ids)[0]
957
yield self.id2path(file_id), self[file_id]
960
if (specific_file_ids is None or yield_parents or
961
self.root.file_id in specific_file_ids):
963
elif isinstance(from_dir, basestring):
964
from_dir = self._byid[from_dir]
966
if specific_file_ids is not None:
967
# TODO: jam 20070302 This could really be done as a loop rather
968
# than a bunch of recursive calls.
971
def add_ancestors(file_id):
972
if file_id not in byid:
974
parent_id = byid[file_id].parent_id
975
if parent_id is None:
977
if parent_id not in parents:
978
parents.add(parent_id)
979
add_ancestors(parent_id)
980
for file_id in specific_file_ids:
981
add_ancestors(file_id)
985
stack = [(u'', from_dir)]
987
cur_relpath, cur_dir = stack.pop()
990
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
992
child_relpath = cur_relpath + child_name
994
if (specific_file_ids is None or
995
child_ie.file_id in specific_file_ids or
996
(yield_parents and child_ie.file_id in parents)):
997
yield child_relpath, child_ie
999
if child_ie.kind == 'directory':
1000
if parents is None or child_ie.file_id in parents:
1001
child_dirs.append((child_relpath+'/', child_ie))
1002
stack.extend(reversed(child_dirs))
1004
def make_entry(self, kind, name, parent_id, file_id=None):
1005
"""Simple thunk to bzrlib.inventory.make_entry."""
1006
return make_entry(kind, name, parent_id, file_id)
332
1008
def entries(self):
333
1009
"""Return list of (path, ie) for all entries except the root.
402
1073
def get_child(self, parent_id, filename):
403
1074
return self[parent_id].children.get(filename)
1076
def _add_child(self, entry):
1077
"""Add an entry to the inventory, without adding it to its parent"""
1078
if entry.file_id in self._byid:
1079
raise BzrError("inventory already contains entry with id {%s}" %
1081
self._byid[entry.file_id] = entry
1082
for child in getattr(entry, 'children', {}).itervalues():
1083
self._add_child(child)
406
1086
def add(self, entry):
407
1087
"""Add entry to inventory.
409
1089
To add a file to a branch ready to be committed, use Branch.add,
1092
Returns the new entry object.
411
1094
if entry.file_id in self._byid:
412
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
414
if entry.parent_id == ROOT_ID or entry.parent_id is None:
415
entry.parent_id = self.root.file_id
418
parent = self._byid[entry.parent_id]
420
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
422
if parent.children.has_key(entry.name):
423
raise BzrError("%s is already versioned" %
424
appendpath(self.id2path(parent.file_id), entry.name))
426
self._byid[entry.file_id] = entry
427
parent.children[entry.name] = entry
430
def add_path(self, relpath, kind, file_id=None):
1095
raise errors.DuplicateFileId(entry.file_id,
1096
self._byid[entry.file_id])
1098
if entry.parent_id is None:
1102
parent = self._byid[entry.parent_id]
1104
raise BzrError("parent_id {%s} not in inventory" %
1107
if entry.name in parent.children:
1108
raise BzrError("%s is already versioned" %
1109
osutils.pathjoin(self.id2path(parent.file_id),
1110
entry.name).encode('utf-8'))
1111
parent.children[entry.name] = entry
1112
return self._add_child(entry)
1114
def add_path(self, relpath, kind, file_id=None, parent_id=None):
431
1115
"""Add entry from a path.
433
The immediate parent must already be versioned"""
434
from bzrlib.branch import gen_file_id
436
parts = bzrlib.osutils.splitpath(relpath)
1117
The immediate parent must already be versioned.
1119
Returns the new entry object."""
1121
parts = osutils.splitpath(relpath)
437
1123
if len(parts) == 0:
438
raise BzrError("cannot re-add root of inventory")
441
file_id = gen_file_id(relpath)
443
parent_path = parts[:-1]
444
parent_id = self.path2id(parent_path)
445
if parent_id == None:
446
raise NotVersionedError(parent_path)
448
ie = InventoryEntry(file_id, parts[-1],
449
kind=kind, parent_id=parent_id)
1125
file_id = generate_ids.gen_root_id()
1126
self.root = InventoryDirectory(file_id, '', None)
1127
self._byid = {self.root.file_id: self.root}
1130
parent_path = parts[:-1]
1131
parent_id = self.path2id(parent_path)
1132
if parent_id is None:
1133
raise errors.NotVersionedError(path=parent_path)
1134
ie = make_entry(kind, parts[-1], parent_id, file_id)
450
1135
return self.add(ie)
453
1137
def __delitem__(self, file_id):
454
1138
"""Remove entry by id.
456
1140
>>> inv = Inventory()
457
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
1141
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1142
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
458
1143
>>> '123' in inv
460
1145
>>> del inv['123']
638
1332
del old_parent.children[file_ie.name]
639
1333
new_parent.children[new_name] = file_ie
641
1335
file_ie.name = new_name
642
1336
file_ie.parent_id = new_parent_id
647
_NAME_RE = re.compile(r'^[^/\\]+$')
1338
def is_root(self, file_id):
1339
return self.root is not None and file_id == self.root.file_id
1341
def filter(self, specific_fileids):
1342
"""Get an inventory view filtered against a set of file-ids.
1344
Children of directories and parents are included.
1346
The result may or may not reference the underlying inventory
1347
so it should be treated as immutable.
1349
interesting_parents = set()
1350
for fileid in specific_fileids:
1352
interesting_parents.update(self.get_idpath(fileid))
1353
except errors.NoSuchId:
1354
# This fileid is not in the inventory - that's ok
1356
entries = self.iter_entries()
1357
if self.root is None:
1358
return Inventory(root_id=None)
1359
other = Inventory(entries.next()[1].file_id)
1360
other.root.revision = self.root.revision
1361
other.revision_id = self.revision_id
1362
directories_to_expand = set()
1363
for path, entry in entries:
1364
file_id = entry.file_id
1365
if (file_id in specific_fileids
1366
or entry.parent_id in directories_to_expand):
1367
if entry.kind == 'directory':
1368
directories_to_expand.add(file_id)
1369
elif file_id not in interesting_parents:
1371
other.add(entry.copy())
1376
'directory': InventoryDirectory,
1377
'file': InventoryFile,
1378
'symlink': InventoryLink,
1379
'tree-reference': TreeReference
1382
def make_entry(kind, name, parent_id, file_id=None):
1383
"""Create an inventory entry.
1385
:param kind: the type of inventory entry to create.
1386
:param name: the basename of the entry.
1387
:param parent_id: the parent_id of the entry.
1388
:param file_id: the file_id to use. if None, one will be created.
1391
file_id = generate_ids.gen_file_id(name)
1392
name = ensure_normalized_name(name)
1394
factory = entry_factory[kind]
1396
raise BzrError("unknown kind %r" % kind)
1397
return factory(file_id, name, parent_id)
1400
def ensure_normalized_name(name):
1403
:raises InvalidNormalization: When name is not normalized, and cannot be
1404
accessed on this platform by the normalized path.
1405
:return: The NFC normalised version of name.
1407
#------- This has been copied to bzrlib.dirstate.DirState.add, please
1408
# keep them synchronised.
1409
# we dont import normalized_filename directly because we want to be
1410
# able to change the implementation at runtime for tests.
1411
norm_name, can_access = osutils.normalized_filename(name)
1412
if norm_name != name:
1416
# TODO: jam 20060701 This would probably be more useful
1417
# if the error was raised with the full path
1418
raise errors.InvalidNormalization(name)
649
1424
def is_valid_name(name):
1426
if _NAME_RE is None:
1427
_NAME_RE = re.compile(r'^[^/\\]+$')
650
1429
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
