23
23
import sys, os.path, types, re
27
from cElementTree import Element, ElementTree, SubElement
29
from elementtree.ElementTree import Element, ElementTree, SubElement
31
from xml import XMLMixin
32
from errors import bailout, BzrError, BzrCheckError
26
from bzrlib.errors import BzrError, BzrCheckError
35
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
36
29
from bzrlib.trace import mutter
30
from bzrlib.errors import NotVersionedError
38
class InventoryEntry(XMLMixin):
33
class InventoryEntry(object):
39
34
"""Description of a versioned file.
41
36
An InventoryEntry has the following fields, which are also
69
64
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
70
65
Traceback (most recent call last):
72
BzrError: ('inventory already contains entry with id {2323}', [])
67
BzrError: inventory already contains entry with id {2323}
73
68
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
74
69
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
75
70
>>> i.path2id('src/wibble')
99
94
# TODO: split InventoryEntry into subclasses for files,
100
95
# directories, etc etc.
97
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
'text_id', 'parent_id', 'children', ]
105
100
def __init__(self, file_id, name, kind, parent_id, text_id=None):
106
101
"""Create an InventoryEntry
145
143
self.parent_id, text_id=self.text_id)
146
144
other.text_sha1 = self.text_sha1
147
145
other.text_size = self.text_size
146
# note that children are *not* copied; they're pulled across when
210
212
from_element = classmethod(from_element)
212
def __cmp__(self, other):
214
def __eq__(self, other):
215
215
if not isinstance(other, InventoryEntry):
216
216
return NotImplemented
218
return cmp(self.file_id, other.file_id) \
219
or cmp(self.name, other.name) \
220
or cmp(self.text_sha1, other.text_sha1) \
221
or cmp(self.text_size, other.text_size) \
222
or cmp(self.text_id, other.text_id) \
223
or cmp(self.parent_id, other.parent_id) \
224
or cmp(self.kind, other.kind)
218
return (self.file_id == other.file_id) \
219
and (self.name == other.name) \
220
and (self.text_sha1 == other.text_sha1) \
221
and (self.text_size == other.text_size) \
222
and (self.text_id == other.text_id) \
223
and (self.parent_id == other.parent_id) \
224
and (self.kind == other.kind)
227
def __ne__(self, other):
228
return not (self == other)
231
raise ValueError('not hashable')
233
240
self.parent_id = None
236
def __cmp__(self, other):
243
def __eq__(self, other):
239
244
if not isinstance(other, RootEntry):
240
245
return NotImplemented
241
return cmp(self.file_id, other.file_id) \
242
or cmp(self.children, other.children)
246
class Inventory(XMLMixin):
247
return (self.file_id == other.file_id) \
248
and (self.children == other.children)
252
class Inventory(object):
247
253
"""Inventory of versioned files in a tree.
249
255
This describes which file_id is present at each point in the tree,
261
267
inserted, other than through the Inventory API.
263
269
>>> inv = Inventory()
264
>>> inv.write_xml(sys.stdout)
267
270
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
268
271
>>> inv['123-123'].name
280
283
>>> [x[0] for x in inv.iter_entries()]
283
>>> inv.write_xml(sys.stdout)
285
<entry file_id="123-123" kind="file" name="hello.c" />
285
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
286
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
288
def __init__(self, root_id=ROOT_ID):
290
289
"""Create or read an inventory.
292
291
If a working directory is specified, the inventory is read
296
295
The inventory is created with a default root directory, with
299
self.root = RootEntry(ROOT_ID)
298
# We are letting Branch(init=True) create a unique inventory
299
# root id. Rather than generating a random one here.
301
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
302
self.root = RootEntry(root_id)
300
303
self._byid = {self.root.file_id: self.root}
324
327
if ie.kind == 'directory':
325
328
for cn, cie in self.iter_entries(from_dir=ie.file_id):
326
329
yield os.path.join(name, cn), cie
333
"""Return list of (path, ie) for all entries except the root.
335
This may be faster than iter_entries.
338
def descend(dir_ie, dir_path):
339
kids = dir_ie.children.items()
341
for name, ie in kids:
342
child_path = os.path.join(dir_path, name)
343
accum.append((child_path, ie))
344
if ie.kind == 'directory':
345
descend(ie, child_path)
347
descend(self.root, '')
330
351
def directories(self):
331
"""Return (path, entry) pairs for all directories.
352
"""Return (path, entry) pairs for all directories, including the root.
333
def descend(parent_ie):
334
parent_name = parent_ie.name
335
yield parent_name, parent_ie
337
# directory children in sorted order
339
for ie in parent_ie.children.itervalues():
340
if ie.kind == 'directory':
341
dn.append((ie.name, ie))
355
def descend(parent_ie, parent_path):
356
accum.append((parent_path, parent_ie))
344
for name, child_ie in dn:
345
for sub_name, sub_ie in descend(child_ie):
346
yield appendpath(parent_name, sub_name), sub_ie
358
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
348
for name, ie in descend(self.root):
361
for name, child_ie in kids:
362
child_path = os.path.join(parent_path, name)
363
descend(child_ie, child_path)
364
descend(self.root, '')
393
409
To add a file to a branch ready to be committed, use Branch.add,
394
410
which calls this."""
395
411
if entry.file_id in self._byid:
396
bailout("inventory already contains entry with id {%s}" % entry.file_id)
412
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
414
if entry.parent_id == ROOT_ID or entry.parent_id is None:
415
entry.parent_id = self.root.file_id
399
418
parent = self._byid[entry.parent_id]
401
bailout("parent_id {%s} not in inventory" % entry.parent_id)
420
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
403
422
if parent.children.has_key(entry.name):
404
bailout("%s is already versioned" %
423
raise BzrError("%s is already versioned" %
405
424
appendpath(self.id2path(parent.file_id), entry.name))
407
426
self._byid[entry.file_id] = entry
412
431
"""Add entry from a path.
414
433
The immediate parent must already be versioned"""
434
from bzrlib.branch import gen_file_id
415
436
parts = bzrlib.osutils.splitpath(relpath)
416
437
if len(parts) == 0:
417
bailout("cannot re-add root of inventory")
438
raise BzrError("cannot re-add root of inventory")
419
440
if file_id == None:
420
file_id = bzrlib.branch.gen_file_id(relpath)
422
parent_id = self.path2id(parts[:-1])
423
assert parent_id != None
441
file_id = gen_file_id(relpath)
443
parent_path = parts[:-1]
444
parent_id = self.path2id(parent_path)
445
if parent_id == None:
446
raise NotVersionedError(parent_path)
424
448
ie = InventoryEntry(file_id, parts[-1],
425
449
kind=kind, parent_id=parent_id)
426
450
return self.add(ie)
452
476
del self[ie.parent_id].children[ie.name]
456
return Set(self._byid)
459
479
def to_element(self):
460
480
"""Convert to XML Element"""
481
from bzrlib.xml import Element
461
483
e = Element('inventory')
485
if self.root.file_id not in (None, ROOT_ID):
486
e.set('file_id', self.root.file_id)
463
487
for path, ie in self.iter_entries():
464
488
e.append(ie.to_element())
468
492
def from_element(cls, elt):
469
493
"""Construct from XML Element
471
495
>>> inv = Inventory()
472
496
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
473
497
>>> elt = inv.to_element()
502
# XXXX: doctest doesn't run this properly under python2.3
478
503
assert elt.tag == 'inventory'
504
root_id = elt.get('file_id') or ROOT_ID
481
o.add(InventoryEntry.from_element(e))
507
ie = InventoryEntry.from_element(e)
508
if ie.parent_id == ROOT_ID:
509
ie.parent_id = root_id
484
513
from_element = classmethod(from_element)
487
def __cmp__(self, other):
516
def __eq__(self, other):
488
517
"""Compare two sets by comparing their contents.
490
519
>>> i1 = Inventory()
504
530
if not isinstance(other, Inventory):
505
531
return NotImplemented
507
if self.id_set() ^ other.id_set():
510
for file_id in self._byid:
511
c = cmp(self[file_id], other[file_id])
533
if len(self._byid) != len(other._byid):
534
# shortcut: obviously not the same
537
return self._byid == other._byid
540
def __ne__(self, other):
541
return not (self == other)
545
raise ValueError('not hashable')
517
549
def get_idpath(self, file_id):
537
569
"""Return as a list the path to file_id."""
539
571
# get all names, skipping root
540
p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
572
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
541
573
return os.sep.join(p)
588
620
This does not move the working file."""
589
621
if not is_valid_name(new_name):
590
bailout("not an acceptable filename: %r" % new_name)
622
raise BzrError("not an acceptable filename: %r" % new_name)
592
624
new_parent = self._byid[new_parent_id]
593
625
if new_name in new_parent.children:
594
bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
626
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
596
628
new_parent_idpath = self.get_idpath(new_parent_id)
597
629
if file_id in new_parent_idpath:
598
bailout("cannot move directory %r into a subdirectory of itself, %r"
630
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
599
631
% (self.id2path(file_id), self.id2path(new_parent_id)))
601
633
file_ie = self._byid[file_id]
added
removed
bzrlib/inventory.py
