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
28
35
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
36
from bzrlib.trace import mutter
30
from bzrlib.errors import NotVersionedError
33
class InventoryEntry(object):
38
class InventoryEntry(XMLMixin):
34
39
"""Description of a versioned file.
36
41
An InventoryEntry has the following fields, which are also
64
69
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
65
70
Traceback (most recent call last):
67
BzrError: inventory already contains entry with id {2323}
72
BzrError: ('inventory already contains entry with id {2323}', [])
68
73
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
69
74
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
70
75
>>> i.path2id('src/wibble')
94
99
# TODO: split InventoryEntry into subclasses for files,
95
100
# directories, etc etc.
97
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
'text_id', 'parent_id', 'children', ]
100
105
def __init__(self, file_id, name, kind, parent_id, text_id=None):
101
106
"""Create an InventoryEntry
143
145
self.parent_id, text_id=self.text_id)
144
146
other.text_sha1 = self.text_sha1
145
147
other.text_size = self.text_size
146
# note that children are *not* copied; they're pulled across when
212
210
from_element = classmethod(from_element)
214
def __eq__(self, other):
212
def __cmp__(self, other):
215
215
if not isinstance(other, InventoryEntry):
216
216
return NotImplemented
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')
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)
240
233
self.parent_id = None
243
def __eq__(self, other):
236
def __cmp__(self, other):
244
239
if not isinstance(other, RootEntry):
245
240
return NotImplemented
247
return (self.file_id == other.file_id) \
248
and (self.children == other.children)
252
class Inventory(object):
241
return cmp(self.file_id, other.file_id) \
242
or cmp(self.children, other.children)
246
class Inventory(XMLMixin):
253
247
"""Inventory of versioned files in a tree.
255
249
This describes which file_id is present at each point in the tree,
267
261
inserted, other than through the Inventory API.
269
263
>>> inv = Inventory()
264
>>> inv.write_xml(sys.stdout)
270
267
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
271
268
>>> inv['123-123'].name
283
280
>>> [x[0] for x in inv.iter_entries()]
285
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
286
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
283
>>> inv.write_xml(sys.stdout)
285
<entry file_id="123-123" kind="file" name="hello.c" />
288
def __init__(self, root_id=ROOT_ID):
289
290
"""Create or read an inventory.
291
292
If a working directory is specified, the inventory is read
295
296
The inventory is created with a default root directory, with
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)
299
self.root = RootEntry(ROOT_ID)
303
300
self._byid = {self.root.file_id: self.root}
327
324
if ie.kind == 'directory':
328
325
for cn, cie in self.iter_entries(from_dir=ie.file_id):
329
326
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.
330
def directories(self):
331
"""Return (path, entry) pairs for all directories.
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))
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():
344
340
if ie.kind == 'directory':
345
descend(ie, child_path)
347
descend(self.root, '')
351
def directories(self):
352
"""Return (path, entry) pairs for all directories, including the root.
355
def descend(parent_ie, parent_path):
356
accum.append((parent_path, parent_ie))
341
dn.append((ie.name, ie))
358
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
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
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, '')
348
for name, ie in descend(self.root):
396
380
raise BzrError("file_id {%s} not in inventory" % file_id)
399
def get_file_kind(self, file_id):
400
return self._byid[file_id].kind
402
383
def get_child(self, parent_id, filename):
403
384
return self[parent_id].children.get(filename)
409
390
To add a file to a branch ready to be committed, use Branch.add,
410
391
which calls this."""
411
392
if entry.file_id in self._byid:
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
393
bailout("inventory already contains entry with id {%s}" % entry.file_id)
418
396
parent = self._byid[entry.parent_id]
420
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
398
bailout("parent_id {%s} not in inventory" % entry.parent_id)
422
400
if parent.children.has_key(entry.name):
423
raise BzrError("%s is already versioned" %
401
bailout("%s is already versioned" %
424
402
appendpath(self.id2path(parent.file_id), entry.name))
426
404
self._byid[entry.file_id] = entry
431
409
"""Add entry from a path.
433
411
The immediate parent must already be versioned"""
434
from bzrlib.branch import gen_file_id
436
412
parts = bzrlib.osutils.splitpath(relpath)
437
413
if len(parts) == 0:
438
raise BzrError("cannot re-add root of inventory")
414
bailout("cannot re-add root of inventory")
440
416
if file_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)
417
file_id = bzrlib.branch.gen_file_id(relpath)
419
parent_id = self.path2id(parts[:-1])
420
assert parent_id != None
448
421
ie = InventoryEntry(file_id, parts[-1],
449
422
kind=kind, parent_id=parent_id)
450
423
return self.add(ie)
476
449
del self[ie.parent_id].children[ie.name]
453
return Set(self._byid)
479
456
def to_element(self):
480
457
"""Convert to XML Element"""
481
from bzrlib.xml import Element
483
458
e = Element('inventory')
485
if self.root.file_id not in (None, ROOT_ID):
486
e.set('file_id', self.root.file_id)
487
460
for path, ie in self.iter_entries():
488
461
e.append(ie.to_element())
492
465
def from_element(cls, elt):
493
466
"""Construct from XML Element
495
468
>>> inv = Inventory()
496
469
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
497
470
>>> elt = inv.to_element()
502
# XXXX: doctest doesn't run this properly under python2.3
503
475
assert elt.tag == 'inventory'
504
root_id = elt.get('file_id') or ROOT_ID
507
ie = InventoryEntry.from_element(e)
508
if ie.parent_id == ROOT_ID:
509
ie.parent_id = root_id
478
o.add(InventoryEntry.from_element(e))
513
481
from_element = classmethod(from_element)
516
def __eq__(self, other):
484
def __cmp__(self, other):
517
485
"""Compare two sets by comparing their contents.
519
487
>>> i1 = Inventory()
530
501
if not isinstance(other, Inventory):
531
502
return NotImplemented
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')
504
if self.id_set() ^ other.id_set():
507
for file_id in self._byid:
508
c = cmp(self[file_id], other[file_id])
549
514
def get_idpath(self, file_id):
569
534
"""Return as a list the path to file_id."""
571
536
# get all names, skipping root
572
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
537
p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
573
538
return os.sep.join(p)
620
585
This does not move the working file."""
621
586
if not is_valid_name(new_name):
622
raise BzrError("not an acceptable filename: %r" % new_name)
587
bailout("not an acceptable filename: %r" % new_name)
624
589
new_parent = self._byid[new_parent_id]
625
590
if new_name in new_parent.children:
626
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
591
bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
628
593
new_parent_idpath = self.get_idpath(new_parent_id)
629
594
if file_id in new_parent_idpath:
630
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
595
bailout("cannot move directory %r into a subdirectory of itself, %r"
631
596
% (self.id2path(file_id), self.id2path(new_parent_id)))
633
598
file_ie = self._byid[file_id]
added
removed
bzrlib/inventory.py
