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.
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
36
44
An InventoryEntry has the following fields, which are also
37
45
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.
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.)
54
73
>>> i = Inventory()
57
76
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
77
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
58
78
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
79
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
59
80
>>> for j in i.iter_entries():
67
88
BzrError: inventory already contains entry with id {2323}
68
89
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
90
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
69
91
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
92
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
70
93
>>> i.path2id('src/wibble')
74
97
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
98
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
76
100
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
77
101
>>> for j in i.iter_entries():
85
109
src/wibble/wibble.c
86
110
>>> i.id2path('2326')
87
111
'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
114
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
'text_id', 'parent_id', 'children', ]
115
'text_id', 'parent_id', 'children',
116
'text_version', 'name_version', ]
100
119
def __init__(self, file_id, name, kind, parent_id, text_id=None):
101
120
"""Create an InventoryEntry
112
131
Traceback (most recent call last):
113
132
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
134
assert isinstance(name, basestring), name
115
135
if '/' in name or '\\' in name:
116
136
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
138
self.text_version = None
139
self.name_version = None
118
140
self.text_sha1 = None
119
141
self.text_size = None
121
142
self.file_id = file_id
142
163
other = InventoryEntry(self.file_id, self.name, self.kind,
143
self.parent_id, text_id=self.text_id)
165
other.text_id = self.text_id
144
166
other.text_sha1 = self.text_sha1
145
167
other.text_size = self.text_size
168
other.text_version = self.text_version
169
other.name_version = self.name_version
146
170
# note that children are *not* copied; they're pulled across when
147
171
# others are added
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
184
def __eq__(self, other):
215
185
if not isinstance(other, InventoryEntry):
216
186
return NotImplemented
221
191
and (self.text_size == other.text_size) \
222
192
and (self.text_id == other.text_id) \
223
193
and (self.parent_id == other.parent_id) \
224
and (self.kind == other.kind)
194
and (self.kind == other.kind) \
195
and (self.text_version == other.text_version) \
196
and (self.name_version == other.name_version)
227
199
def __ne__(self, other):
269
241
>>> inv = Inventory()
270
242
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
243
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
271
244
>>> inv['123-123'].name
285
258
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
286
259
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
260
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
288
262
def __init__(self, root_id=ROOT_ID):
289
263
"""Create or read an inventory.
303
277
self._byid = {self.root.file_id: self.root}
281
other = Inventory(self.root.file_id)
282
# copy recursively so we know directories will be added before
283
# their children. There are more efficient ways than this...
284
for path, entry in self.iter_entries():
285
if entry == self.root:
287
other.add(entry.copy())
306
291
def __iter__(self):
307
292
return iter(self._byid)
372
357
>>> inv = Inventory()
373
358
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
359
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
385
371
>>> inv = Inventory()
386
372
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
373
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
387
374
>>> inv['123123'].name
407
394
"""Add entry to inventory.
409
396
To add a file to a branch ready to be committed, use Branch.add,
399
Returns the new entry object.
411
401
if entry.file_id in self._byid:
412
402
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
426
416
self._byid[entry.file_id] = entry
427
417
parent.children[entry.name] = entry
430
421
def add_path(self, relpath, kind, file_id=None):
431
422
"""Add entry from a path.
433
The immediate parent must already be versioned"""
424
The immediate parent must already be versioned.
426
Returns the new entry object."""
434
427
from bzrlib.branch import gen_file_id
436
429
parts = bzrlib.osutils.splitpath(relpath)
456
449
>>> inv = Inventory()
457
450
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
451
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
460
454
>>> del inv['123']
476
470
del self[ie.parent_id].children[ie.name]
479
def to_element(self):
480
"""Convert to XML Element"""
481
from bzrlib.xml import Element
483
e = Element('inventory')
485
if self.root.file_id not in (None, ROOT_ID):
486
e.set('file_id', self.root.file_id)
487
for path, ie in self.iter_entries():
488
e.append(ie.to_element())
492
def from_element(cls, elt):
493
"""Construct from XML Element
495
>>> inv = Inventory()
496
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
497
>>> elt = inv.to_element()
498
>>> inv2 = Inventory.from_element(elt)
502
# XXXX: doctest doesn't run this properly under python2.3
503
assert elt.tag == 'inventory'
504
root_id = elt.get('file_id') or ROOT_ID
507
ie = InventoryEntry.from_element(e)
508
if ie.parent_id == ROOT_ID:
509
ie.parent_id = root_id
513
from_element = classmethod(from_element)
516
473
def __eq__(self, other):
517
474
"""Compare two sets by comparing their contents.
523
480
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
481
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
526
484
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
485
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
540
499
def __ne__(self, other):
541
return not (self == other)
500
return not self.__eq__(other)
544
503
def __hash__(self):
545
504
raise ValueError('not hashable')
549
507
def get_idpath(self, file_id):
550
508
"""Return a list of file_ids for the path to an entry.
added
removed
bzrlib/inventory.py
