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"
44
36
An InventoryEntry has the following fields, which are also
45
37
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.)
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.
73
54
>>> i = Inventory()
109
90
src/wibble/wibble.c
110
91
>>> i.id2path('2326')
111
92
'src/wibble/wibble.c'
94
TODO: Maybe also keep the full path of the entry, and the children?
95
But those depend on its position within a particular inventory, and
96
it would be nice not to need to hold the backpointer here.
99
# TODO: split InventoryEntry into subclasses for files,
100
# directories, etc etc.
114
102
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
115
'text_id', 'parent_id', 'children',
116
'text_version', 'entry_version', ]
103
'text_id', 'parent_id', 'children', ]
119
105
def __init__(self, file_id, name, kind, parent_id, text_id=None):
120
106
"""Create an InventoryEntry
131
117
Traceback (most recent call last):
132
118
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
134
assert isinstance(name, basestring), name
135
120
if '/' in name or '\\' in name:
136
121
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
138
self.text_version = None
139
self.entry_version = None
140
123
self.text_sha1 = None
141
124
self.text_size = None
142
126
self.file_id = file_id
163
147
other = InventoryEntry(self.file_id, self.name, self.kind,
165
other.text_id = self.text_id
148
self.parent_id, text_id=self.text_id)
166
149
other.text_sha1 = self.text_sha1
167
150
other.text_size = self.text_size
168
other.text_version = self.text_version
169
151
# note that children are *not* copied; they're pulled across when
170
152
# others are added
165
def to_element(self):
166
"""Convert to XML element"""
167
from bzrlib.xml import Element
171
e.set('name', self.name)
172
e.set('file_id', self.file_id)
173
e.set('kind', self.kind)
175
if self.text_size != None:
176
e.set('text_size', '%d' % self.text_size)
178
for f in ['text_id', 'text_sha1']:
183
# to be conservative, we don't externalize the root pointers
184
# for now, leaving them as null in the xml form. in a future
185
# version it will be implied by nested elements.
186
if self.parent_id != ROOT_ID:
187
assert isinstance(self.parent_id, basestring)
188
e.set('parent_id', self.parent_id)
195
def from_element(cls, elt):
196
assert elt.tag == 'entry'
198
## original format inventories don't have a parent_id for
199
## nodes in the root directory, but it's cleaner to use one
201
parent_id = elt.get('parent_id')
202
if parent_id == None:
205
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
206
self.text_id = elt.get('text_id')
207
self.text_sha1 = elt.get('text_sha1')
209
## mutter("read inventoryentry: %r" % (elt.attrib))
211
v = elt.get('text_size')
212
self.text_size = v and int(v)
217
from_element = classmethod(from_element)
183
219
def __eq__(self, other):
184
220
if not isinstance(other, InventoryEntry):
185
221
return NotImplemented
190
226
and (self.text_size == other.text_size) \
191
227
and (self.text_id == other.text_id) \
192
228
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)
229
and (self.kind == other.kind)
198
232
def __ne__(self, other):
276
310
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
313
def __iter__(self):
291
314
return iter(self._byid)
393
416
"""Add entry to inventory.
395
418
To add a file to a branch ready to be committed, use Branch.add,
398
Returns the new entry object.
400
420
if entry.file_id in self._byid:
401
421
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
420
440
def add_path(self, relpath, kind, file_id=None):
421
441
"""Add entry from a path.
423
The immediate parent must already be versioned.
425
Returns the new entry object."""
443
The immediate parent must already be versioned"""
426
444
from bzrlib.branch import gen_file_id
428
446
parts = bzrlib.osutils.splitpath(relpath)
469
487
del self[ie.parent_id].children[ie.name]
490
def to_element(self):
491
"""Convert to XML Element"""
492
from bzrlib.xml import Element
494
e = Element('inventory')
496
if self.root.file_id not in (None, ROOT_ID):
497
e.set('file_id', self.root.file_id)
498
for path, ie in self.iter_entries():
499
e.append(ie.to_element())
503
def from_element(cls, elt):
504
"""Construct from XML Element
506
>>> inv = Inventory()
507
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
508
InventoryEntry('foo.c-123981239', 'foo.c', kind='file', parent_id='TREE_ROOT')
509
>>> elt = inv.to_element()
510
>>> inv2 = Inventory.from_element(elt)
514
# XXXX: doctest doesn't run this properly under python2.3
515
assert elt.tag == 'inventory'
516
root_id = elt.get('file_id') or ROOT_ID
519
ie = InventoryEntry.from_element(e)
520
if ie.parent_id == ROOT_ID:
521
ie.parent_id = root_id
525
from_element = classmethod(from_element)
472
528
def __eq__(self, other):
473
529
"""Compare two sets by comparing their contents.