15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Maybe also keep the full path of the entry, and the children?
19
# But those depend on its position within a particular inventory, and
20
# it would be nice not to need to hold the backpointer here.
22
# TODO: Perhaps split InventoryEntry into subclasses for files,
23
# directories, etc etc.
26
18
# This should really be an id randomly assigned when the tree is
27
19
# created, but it's not for now.
28
20
ROOT_ID = "TREE_ROOT"
36
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
37
29
from bzrlib.trace import mutter
38
from bzrlib.errors import NotVersionedError
41
31
class InventoryEntry(object):
42
32
"""Description of a versioned file.
44
34
An InventoryEntry has the following fields, which are also
45
35
present in the XML inventory-entry element:
50
(within the parent directory)
56
file_id of the parent directory, or ROOT_ID
59
the revision_id in which the name or parent of this file was
63
sha-1 of the text of the file
66
size in bytes of the text of the file
69
the revision_id in which the text of this file was introduced
71
(reading a version 4 tree created a text_id field.)
38
* *name*: (only the basename within the directory, must not
40
* *kind*: "directory" or "file"
41
* *directory_id*: (if absent/null means the branch root directory)
42
* *text_sha1*: only for files
43
* *text_size*: in bytes, only for files
44
* *text_id*: identifier for the text version, only for files
46
InventoryEntries can also exist inside a WorkingTree
47
inventory, in which case they are not yet bound to a
48
particular revision of the file. In that case the text_sha1,
49
text_size and text_id are absent.
73
52
>>> i = Inventory()
76
55
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
77
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
78
56
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
79
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
80
57
>>> for j in i.iter_entries():
88
65
BzrError: inventory already contains entry with id {2323}
89
66
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
90
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
91
67
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
92
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
93
68
>>> i.path2id('src/wibble')
97
72
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
98
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
100
74
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
101
75
>>> for j in i.iter_entries():
109
83
src/wibble/wibble.c
110
84
>>> i.id2path('2326')
111
85
'src/wibble/wibble.c'
87
TODO: Maybe also keep the full path of the entry, and the children?
88
But those depend on its position within a particular inventory, and
89
it would be nice not to need to hold the backpointer here.
92
# TODO: split InventoryEntry into subclasses for files,
93
# directories, etc etc.
114
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
115
'text_id', 'parent_id', 'children',
116
'text_version', 'entry_version', ]
119
98
def __init__(self, file_id, name, kind, parent_id, text_id=None):
120
99
"""Create an InventoryEntry
131
110
Traceback (most recent call last):
132
111
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
134
assert isinstance(name, basestring), name
135
113
if '/' in name or '\\' in name:
136
114
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
138
self.text_version = None
139
self.entry_version = None
140
self.text_sha1 = None
141
self.text_size = None
142
116
self.file_id = file_id
163
137
other = InventoryEntry(self.file_id, self.name, self.kind,
165
other.text_id = self.text_id
138
self.parent_id, text_id=self.text_id)
166
139
other.text_sha1 = self.text_sha1
167
140
other.text_size = self.text_size
168
141
# note that children are *not* copied; they're pulled across when
155
def to_element(self):
156
"""Convert to XML element"""
157
from bzrlib.xml import Element
161
e.set('name', self.name)
162
e.set('file_id', self.file_id)
163
e.set('kind', self.kind)
165
if self.text_size != None:
166
e.set('text_size', '%d' % self.text_size)
168
for f in ['text_id', 'text_sha1']:
173
# to be conservative, we don't externalize the root pointers
174
# for now, leaving them as null in the xml form. in a future
175
# version it will be implied by nested elements.
176
if self.parent_id != ROOT_ID:
177
assert isinstance(self.parent_id, basestring)
178
e.set('parent_id', self.parent_id)
185
def from_element(cls, elt):
186
assert elt.tag == 'entry'
188
## original format inventories don't have a parent_id for
189
## nodes in the root directory, but it's cleaner to use one
191
parent_id = elt.get('parent_id')
192
if parent_id == None:
195
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
196
self.text_id = elt.get('text_id')
197
self.text_sha1 = elt.get('text_sha1')
199
## mutter("read inventoryentry: %r" % (elt.attrib))
201
v = elt.get('text_size')
202
self.text_size = v and int(v)
207
from_element = classmethod(from_element)
182
209
def __eq__(self, other):
183
210
if not isinstance(other, InventoryEntry):
184
211
return NotImplemented
189
216
and (self.text_size == other.text_size) \
190
217
and (self.text_id == other.text_id) \
191
218
and (self.parent_id == other.parent_id) \
192
and (self.kind == other.kind) \
193
and (self.text_version == other.text_version) \
194
and (self.entry_version == other.entry_version)
219
and (self.kind == other.kind)
197
222
def __ne__(self, other):
239
264
>>> inv = Inventory()
240
265
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
241
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
242
266
>>> inv['123-123'].name
256
280
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
257
281
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
258
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
260
283
def __init__(self, root_id=ROOT_ID):
261
284
"""Create or read an inventory.
353
367
>>> inv = Inventory()
354
368
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
355
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
367
380
>>> inv = Inventory()
368
381
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
369
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
370
382
>>> inv['123123'].name
390
402
"""Add entry to inventory.
392
404
To add a file to a branch ready to be committed, use Branch.add,
395
Returns the new entry object.
397
406
if entry.file_id in self._byid:
398
407
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
412
421
self._byid[entry.file_id] = entry
413
422
parent.children[entry.name] = entry
417
425
def add_path(self, relpath, kind, file_id=None):
418
426
"""Add entry from a path.
420
The immediate parent must already be versioned.
422
Returns the new entry object."""
423
from bzrlib.branch import gen_file_id
428
The immediate parent must already be versioned"""
429
from bzrlib.errors import NotVersionedError
425
431
parts = bzrlib.osutils.splitpath(relpath)
426
432
if len(parts) == 0:
427
433
raise BzrError("cannot re-add root of inventory")
429
435
if file_id == None:
436
from bzrlib.branch import gen_file_id
430
437
file_id = gen_file_id(relpath)
432
439
parent_path = parts[:-1]
445
452
>>> inv = Inventory()
446
453
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
447
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
450
456
>>> del inv['123']
466
472
del self[ie.parent_id].children[ie.name]
475
def to_element(self):
476
"""Convert to XML Element"""
477
from bzrlib.xml import Element
479
e = Element('inventory')
481
if self.root.file_id not in (None, ROOT_ID):
482
e.set('file_id', self.root.file_id)
483
for path, ie in self.iter_entries():
484
e.append(ie.to_element())
488
def from_element(cls, elt):
489
"""Construct from XML Element
491
>>> inv = Inventory()
492
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
493
>>> elt = inv.to_element()
494
>>> inv2 = Inventory.from_element(elt)
498
# XXXX: doctest doesn't run this properly under python2.3
499
assert elt.tag == 'inventory'
500
root_id = elt.get('file_id') or ROOT_ID
503
ie = InventoryEntry.from_element(e)
504
if ie.parent_id == ROOT_ID:
505
ie.parent_id = root_id
509
from_element = classmethod(from_element)
469
512
def __eq__(self, other):
470
513
"""Compare two sets by comparing their contents.
476
519
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
477
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
480
522
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
481
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
added
removed
bzrlib/inventory.py
