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"
23
import sys, os.path, types, re
26
37
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
39
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath
29
40
from bzrlib.trace import mutter
30
41
from bzrlib.errors import NotVersionedError
33
44
class InventoryEntry(object):
34
45
"""Description of a versioned file.
36
47
An InventoryEntry has the following fields, which are also
37
48
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.
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.)
54
76
>>> i = Inventory()
79
101
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
81
103
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
>>> for j in i.iter_entries():
84
... assert i.path2id(j[0])
104
>>> for path, entry in i.iter_entries():
105
... print path.replace('\\\\', '/') # for win32 os.sep
106
... assert i.path2id(path)
90
112
src/wibble/wibble.c
113
>>> i.id2path('2326').replace('\\\\', '/')
92
114
'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.
102
117
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
103
'text_id', 'parent_id', 'children', ]
118
'text_id', 'parent_id', 'children',
119
'text_version', 'name_version', ]
105
122
def __init__(self, file_id, name, kind, parent_id, text_id=None):
106
123
"""Create an InventoryEntry
117
134
Traceback (most recent call last):
118
135
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
137
assert isinstance(name, basestring), name
120
138
if '/' in name or '\\' in name:
121
139
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
141
self.text_version = None
142
self.name_version = None
123
143
self.text_sha1 = None
124
144
self.text_size = None
126
145
self.file_id = file_id
147
166
other = InventoryEntry(self.file_id, self.name, self.kind,
148
self.parent_id, text_id=self.text_id)
168
other.text_id = self.text_id
149
169
other.text_sha1 = self.text_sha1
150
170
other.text_size = self.text_size
171
other.text_version = self.text_version
172
other.name_version = self.name_version
151
173
# note that children are *not* copied; they're pulled across when
152
174
# 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)
219
187
def __eq__(self, other):
220
188
if not isinstance(other, InventoryEntry):
221
189
return NotImplemented
226
194
and (self.text_size == other.text_size) \
227
195
and (self.text_id == other.text_id) \
228
196
and (self.parent_id == other.parent_id) \
229
and (self.kind == other.kind)
197
and (self.kind == other.kind) \
198
and (self.text_version == other.text_version) \
199
and (self.name_version == other.name_version)
232
202
def __ne__(self, other):
302
272
The inventory is created with a default root directory, with
305
# We are letting Branch(init=True) create a unique inventory
275
# We are letting Branch.initialize() create a unique inventory
306
276
# root id. Rather than generating a random one here.
307
277
#if root_id is None:
308
278
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
310
280
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())
313
294
def __iter__(self):
314
295
return iter(self._byid)
416
397
"""Add entry to inventory.
418
399
To add a file to a branch ready to be committed, use Branch.add,
402
Returns the new entry object.
420
404
if entry.file_id in self._byid:
421
405
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
440
424
def add_path(self, relpath, kind, file_id=None):
441
425
"""Add entry from a path.
443
The immediate parent must already be versioned"""
427
The immediate parent must already be versioned.
429
Returns the new entry object."""
444
430
from bzrlib.branch import gen_file_id
446
432
parts = bzrlib.osutils.splitpath(relpath)
487
473
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)
528
476
def __eq__(self, other):
529
477
"""Compare two sets by comparing their contents.
554
502
def __ne__(self, other):
555
return not (self == other)
503
return not self.__eq__(other)
558
506
def __hash__(self):
559
507
raise ValueError('not hashable')
563
510
def get_idpath(self, file_id):
564
511
"""Return a list of file_ids for the path to an entry.
added
removed
bzrlib/inventory.py
