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"
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
37
from bzrlib.errors import BzrError, BzrCheckError
39
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath
34
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
40
35
from bzrlib.trace import mutter
41
from bzrlib.errors import NotVersionedError
44
class InventoryEntry(object):
37
class InventoryEntry(XMLMixin):
45
38
"""Description of a versioned file.
47
40
An InventoryEntry has the following fields, which are also
48
41
present in the XML inventory-entry element:
53
(within the parent directory)
59
file_id of the parent directory, or ROOT_ID
62
the revision_id in which the name or parent of this file was
66
sha-1 of the text of the file
69
size in bytes of the text of the file
72
the revision_id in which the text of this file was introduced
74
(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.
76
58
>>> i = Inventory()
79
61
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
80
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
81
62
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
82
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
83
63
>>> for j in i.iter_entries():
91
71
BzrError: inventory already contains entry with id {2323}
92
72
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
93
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
94
73
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
95
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
96
74
>>> i.path2id('src/wibble')
100
78
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
101
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
103
80
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
104
>>> for path, entry in i.iter_entries():
105
... print path.replace('\\\\', '/') # for win32 os.sep
106
... assert i.path2id(path)
81
>>> for j in i.iter_entries():
83
... assert i.path2id(j[0])
112
89
src/wibble/wibble.c
113
>>> i.id2path('2326').replace('\\\\', '/')
114
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.
117
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
118
'text_id', 'parent_id', 'children',
119
'text_version', 'name_version', ]
122
104
def __init__(self, file_id, name, kind, parent_id, text_id=None):
123
105
"""Create an InventoryEntry
166
143
other = InventoryEntry(self.file_id, self.name, self.kind,
168
other.text_id = self.text_id
144
self.parent_id, text_id=self.text_id)
169
145
other.text_sha1 = self.text_sha1
170
146
other.text_size = self.text_size
171
other.text_version = self.text_version
172
other.name_version = self.name_version
173
147
# note that children are *not* copied; they're pulled across when
174
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)
187
213
def __eq__(self, other):
188
214
if not isinstance(other, InventoryEntry):
189
215
return NotImplemented
259
285
>>> [x[0] for x in inv.iter_entries()]
261
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
262
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
263
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" />
265
def __init__(self, root_id=ROOT_ID):
266
295
"""Create or read an inventory.
268
297
If a working directory is specified, the inventory is read
272
301
The inventory is created with a default root directory, with
275
# We are letting Branch.initialize() create a unique inventory
276
# root id. Rather than generating a random one here.
278
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
279
self.root = RootEntry(root_id)
304
self.root = RootEntry(ROOT_ID)
280
305
self._byid = {self.root.file_id: self.root}
284
other = Inventory(self.root.file_id)
285
# copy recursively so we know directories will be added before
286
# their children. There are more efficient ways than this...
287
for path, entry in self.iter_entries():
288
if entry == self.root:
290
other.add(entry.copy())
294
308
def __iter__(self):
295
309
return iter(self._byid)
419
425
self._byid[entry.file_id] = entry
420
426
parent.children[entry.name] = entry
424
429
def add_path(self, relpath, kind, file_id=None):
425
430
"""Add entry from a path.
427
The immediate parent must already be versioned.
429
Returns the new entry object."""
430
from bzrlib.branch import gen_file_id
432
The immediate parent must already be versioned"""
433
from bzrlib.errors import NotVersionedError
432
435
parts = bzrlib.osutils.splitpath(relpath)
433
436
if len(parts) == 0:
434
437
raise BzrError("cannot re-add root of inventory")
436
439
if file_id == None:
437
file_id = gen_file_id(relpath)
440
file_id = bzrlib.branch.gen_file_id(relpath)
439
442
parent_path = parts[:-1]
440
443
parent_id = self.path2id(parent_path)
473
475
del self[ie.parent_id].children[ie.name]
478
def to_element(self):
479
"""Convert to XML Element"""
480
e = Element('inventory')
482
for path, ie in self.iter_entries():
483
e.append(ie.to_element())
487
def from_element(cls, elt):
488
"""Construct from XML Element
490
>>> inv = Inventory()
491
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
492
>>> elt = inv.to_element()
493
>>> inv2 = Inventory.from_element(elt)
497
assert elt.tag == 'inventory'
500
o.add(InventoryEntry.from_element(e))
503
from_element = classmethod(from_element)
476
506
def __eq__(self, other):
477
507
"""Compare two sets by comparing their contents.
added
removed
bzrlib/inventory.py
