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"
31
23
import sys, os.path, types, re
26
from cElementTree import Element, ElementTree, SubElement
28
from elementtree.ElementTree import Element, ElementTree, SubElement
30
from bzrlib.xml import XMLMixin
31
from bzrlib.errors import BzrError, BzrCheckError
34
from bzrlib.errors import BzrError, BzrCheckError
36
34
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
37
35
from bzrlib.trace import mutter
38
from bzrlib.errors import NotVersionedError
41
class InventoryEntry(object):
37
class InventoryEntry(XMLMixin):
42
38
"""Description of a versioned file.
44
40
An InventoryEntry has the following fields, which are also
45
41
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.)
44
* *name*: (only the basename within the directory, must not
46
* *kind*: "directory" or "file"
47
* *directory_id*: (if absent/null means the branch root directory)
48
* *text_sha1*: only for files
49
* *text_size*: in bytes, only for files
50
* *text_id*: identifier for the text version, only for files
52
InventoryEntries can also exist inside a WorkingTree
53
inventory, in which case they are not yet bound to a
54
particular revision of the file. In that case the text_sha1,
55
text_size and text_id are absent.
73
58
>>> i = Inventory()
76
61
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
77
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
78
62
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
79
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
80
63
>>> for j in i.iter_entries():
88
71
BzrError: inventory already contains entry with id {2323}
89
72
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
90
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
91
73
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
92
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
93
74
>>> i.path2id('src/wibble')
97
78
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
98
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
100
80
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
101
81
>>> for j in i.iter_entries():
109
89
src/wibble/wibble.c
110
90
>>> i.id2path('2326')
111
91
'src/wibble/wibble.c'
93
TODO: Maybe also keep the full path of the entry, and the children?
94
But those depend on its position within a particular inventory, and
95
it would be nice not to need to hold the backpointer here.
98
# TODO: split InventoryEntry into subclasses for files,
99
# 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
104
def __init__(self, file_id, name, kind, parent_id, text_id=None):
120
105
"""Create an InventoryEntry
131
116
Traceback (most recent call last):
132
117
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
134
assert isinstance(name, basestring), name
135
119
if '/' in name or '\\' in name:
136
120
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
122
self.file_id = file_id
163
143
other = InventoryEntry(self.file_id, self.name, self.kind,
165
other.text_id = self.text_id
144
self.parent_id, text_id=self.text_id)
166
145
other.text_sha1 = self.text_sha1
167
146
other.text_size = self.text_size
168
other.text_version = self.text_version
169
147
# note that children are *not* copied; they're pulled across when
170
148
# others are added
161
def to_element(self):
162
"""Convert to XML element"""
165
e.set('name', self.name)
166
e.set('file_id', self.file_id)
167
e.set('kind', self.kind)
169
if self.text_size != None:
170
e.set('text_size', '%d' % self.text_size)
172
for f in ['text_id', 'text_sha1']:
177
# to be conservative, we don't externalize the root pointers
178
# for now, leaving them as null in the xml form. in a future
179
# version it will be implied by nested elements.
180
if self.parent_id != ROOT_ID:
181
assert isinstance(self.parent_id, basestring)
182
e.set('parent_id', self.parent_id)
189
def from_element(cls, elt):
190
assert elt.tag == 'entry'
192
## original format inventories don't have a parent_id for
193
## nodes in the root directory, but it's cleaner to use one
195
parent_id = elt.get('parent_id')
196
if parent_id == None:
199
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
200
self.text_id = elt.get('text_id')
201
self.text_sha1 = elt.get('text_sha1')
203
## mutter("read inventoryentry: %r" % (elt.attrib))
205
v = elt.get('text_size')
206
self.text_size = v and int(v)
211
from_element = classmethod(from_element)
183
213
def __eq__(self, other):
184
214
if not isinstance(other, InventoryEntry):
185
215
return NotImplemented
190
220
and (self.text_size == other.text_size) \
191
221
and (self.text_id == other.text_id) \
192
222
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)
223
and (self.kind == other.kind)
198
226
def __ne__(self, other):
238
266
inserted, other than through the Inventory API.
240
268
>>> inv = Inventory()
269
>>> inv.write_xml(sys.stdout)
241
272
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
242
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
243
273
>>> inv['123-123'].name
255
285
>>> [x[0] for x in inv.iter_entries()]
257
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
258
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
259
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
288
>>> inv.write_xml(sys.stdout)
290
<entry file_id="123-123" kind="file" name="hello.c" />
261
def __init__(self, root_id=ROOT_ID):
262
295
"""Create or read an inventory.
264
297
If a working directory is specified, the inventory is read
268
301
The inventory is created with a default root directory, with
271
# We are letting Branch(init=True) create a unique inventory
272
# root id. Rather than generating a random one here.
274
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
275
self.root = RootEntry(root_id)
304
self.root = RootEntry(ROOT_ID)
276
305
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
308
def __iter__(self):
291
309
return iter(self._byid)
393
409
"""Add entry to inventory.
395
411
To add a file to a branch ready to be committed, use Branch.add,
398
Returns the new entry object.
400
413
if entry.file_id in self._byid:
401
414
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
403
if entry.parent_id == ROOT_ID or entry.parent_id is None:
404
entry.parent_id = self.root.file_id
407
417
parent = self._byid[entry.parent_id]
415
425
self._byid[entry.file_id] = entry
416
426
parent.children[entry.name] = entry
420
429
def add_path(self, relpath, kind, file_id=None):
421
430
"""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
432
The immediate parent must already be versioned"""
428
433
parts = bzrlib.osutils.splitpath(relpath)
429
434
if len(parts) == 0:
430
435
raise BzrError("cannot re-add root of inventory")
432
437
if file_id == None:
433
file_id = gen_file_id(relpath)
435
parent_path = parts[:-1]
436
parent_id = self.path2id(parent_path)
437
if parent_id == None:
438
raise NotVersionedError(parent_path)
438
file_id = bzrlib.branch.gen_file_id(relpath)
440
parent_id = self.path2id(parts[:-1])
441
assert parent_id != None
440
442
ie = InventoryEntry(file_id, parts[-1],
441
443
kind=kind, parent_id=parent_id)
442
444
return self.add(ie)
469
470
del self[ie.parent_id].children[ie.name]
473
def to_element(self):
474
"""Convert to XML Element"""
475
e = Element('inventory')
477
for path, ie in self.iter_entries():
478
e.append(ie.to_element())
482
def from_element(cls, elt):
483
"""Construct from XML Element
485
>>> inv = Inventory()
486
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
487
>>> elt = inv.to_element()
488
>>> inv2 = Inventory.from_element(elt)
492
assert elt.tag == 'inventory'
495
o.add(InventoryEntry.from_element(e))
498
from_element = classmethod(from_element)
472
501
def __eq__(self, other):
473
502
"""Compare two sets by comparing their contents.
479
508
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
480
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
483
511
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
484
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
added
removed
bzrlib/inventory.py
