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
95
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
115
'text_id', 'parent_id', 'children',
116
'text_version', 'entry_version', ]
96
'text_id', 'parent_id', 'children', ]
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
116
self.text_sha1 = None
141
117
self.text_size = None
142
119
self.file_id = file_id
163
140
other = InventoryEntry(self.file_id, self.name, self.kind,
165
other.text_id = self.text_id
141
self.parent_id, text_id=self.text_id)
166
142
other.text_sha1 = self.text_sha1
167
143
other.text_size = self.text_size
168
other.text_version = self.text_version
169
144
# note that children are *not* copied; they're pulled across when
170
145
# others are added
158
def to_element(self):
159
"""Convert to XML element"""
160
from bzrlib.xml import Element
164
e.set('name', self.name)
165
e.set('file_id', self.file_id)
166
e.set('kind', self.kind)
168
if self.text_size != None:
169
e.set('text_size', '%d' % self.text_size)
171
for f in ['text_id', 'text_sha1']:
176
# to be conservative, we don't externalize the root pointers
177
# for now, leaving them as null in the xml form. in a future
178
# version it will be implied by nested elements.
179
if self.parent_id != ROOT_ID:
180
assert isinstance(self.parent_id, basestring)
181
e.set('parent_id', self.parent_id)
188
def from_element(cls, elt):
189
assert elt.tag == 'entry'
191
## original format inventories don't have a parent_id for
192
## nodes in the root directory, but it's cleaner to use one
194
parent_id = elt.get('parent_id')
195
if parent_id == None:
198
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
199
self.text_id = elt.get('text_id')
200
self.text_sha1 = elt.get('text_sha1')
202
## mutter("read inventoryentry: %r" % (elt.attrib))
204
v = elt.get('text_size')
205
self.text_size = v and int(v)
210
from_element = classmethod(from_element)
183
212
def __eq__(self, other):
184
213
if not isinstance(other, InventoryEntry):
185
214
return NotImplemented
190
219
and (self.text_size == other.text_size) \
191
220
and (self.text_id == other.text_id) \
192
221
and (self.parent_id == other.parent_id) \
193
and (self.kind == other.kind) \
194
and (self.text_version == other.text_version) \
195
and (self.entry_version == other.entry_version)
222
and (self.kind == other.kind)
198
225
def __ne__(self, other):
240
267
>>> inv = Inventory()
241
268
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
242
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
243
269
>>> inv['123-123'].name
257
283
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
258
284
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
259
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
261
286
def __init__(self, root_id=ROOT_ID):
262
287
"""Create or read an inventory.
276
301
self._byid = {self.root.file_id: self.root}
280
other = Inventory(self.root.file_id)
281
# copy recursively so we know directories will be added before
282
# their children. There are more efficient ways than this...
283
for path, entry in self.iter_entries():
284
if entry == self.root:
286
other.add(entry.copy())
290
304
def __iter__(self):
291
305
return iter(self._byid)
356
370
>>> inv = Inventory()
357
371
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
358
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
370
383
>>> inv = Inventory()
371
384
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
372
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
373
385
>>> inv['123123'].name
393
405
"""Add entry to inventory.
395
407
To add a file to a branch ready to be committed, use Branch.add,
398
Returns the new entry object.
400
409
if entry.file_id in self._byid:
401
410
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
415
424
self._byid[entry.file_id] = entry
416
425
parent.children[entry.name] = entry
420
428
def add_path(self, relpath, kind, file_id=None):
421
429
"""Add entry from a path.
423
The immediate parent must already be versioned.
425
Returns the new entry object."""
426
from bzrlib.branch import gen_file_id
431
The immediate parent must already be versioned"""
432
from bzrlib.errors import NotVersionedError
428
434
parts = bzrlib.osutils.splitpath(relpath)
429
435
if len(parts) == 0:
430
436
raise BzrError("cannot re-add root of inventory")
432
438
if file_id == None:
439
from bzrlib.branch import gen_file_id
433
440
file_id = gen_file_id(relpath)
435
442
parent_path = parts[:-1]
448
455
>>> inv = Inventory()
449
456
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
450
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
453
459
>>> del inv['123']
469
475
del self[ie.parent_id].children[ie.name]
478
def to_element(self):
479
"""Convert to XML Element"""
480
from bzrlib.xml import Element
482
e = Element('inventory')
484
if self.root.file_id not in (None, ROOT_ID):
485
e.set('file_id', self.root.file_id)
486
for path, ie in self.iter_entries():
487
e.append(ie.to_element())
491
def from_element(cls, elt):
492
"""Construct from XML Element
494
>>> inv = Inventory()
495
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
496
>>> elt = inv.to_element()
497
>>> inv2 = Inventory.from_element(elt)
501
# XXXX: doctest doesn't run this properly under python2.3
502
assert elt.tag == 'inventory'
503
root_id = elt.get('file_id') or ROOT_ID
506
ie = InventoryEntry.from_element(e)
507
if ie.parent_id == ROOT_ID:
508
ie.parent_id = root_id
512
from_element = classmethod(from_element)
472
515
def __eq__(self, other):
473
516
"""Compare two sets by comparing their contents.
479
522
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
480
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
483
525
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
484
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
added
removed
bzrlib/inventory.py
